@googleapis/dataform 17.0.0 → 17.2.0

package/build/v1beta1.d.ts

@@ -194,6 +194,19 @@ export declare namespace dataform_v1beta1 {
          */
         role?: string | null;
     }
+    /**
+     * Contains metadata about a branch.
+     */
+    export interface Schema$BranchMetadata {
+        /**
+         * The branch name.
+         */
+        branchName?: string | null;
+        /**
+         * The last commit on the branch.
+         */
+        lastCommit?: Schema$CommitLogEntry;
+    }
     /**
      * The request message for Operations.CancelOperation.
      */
@@ -209,6 +222,23 @@ export declare namespace dataform_v1beta1 {
      */
     export interface Schema$CancelWorkflowInvocationResponse {
     }
+    /**
+     * `CheckoutWorkspaceBranch` request message.
+     */
+    export interface Schema$CheckoutWorkspaceBranchRequest {
+        /**
+         * Required. The name of the branch in the Git repository to which the workspace should be checked out.
+         */
+        branch?: string | null;
+        /**
+         * Optional. If set to true and the branch does not exist, it will be created. Otherwise, an error will be thrown.
+         */
+        createIfNotExists?: boolean | null;
+        /**
+         * 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.
+         */
+        sourceBranch?: string | null;
+    }
     /**
      * Configures various aspects of Dataform code compilation.
      */
@@ -241,6 +271,10 @@ export declare namespace dataform_v1beta1 {
          * Optional. The default schema (BigQuery dataset ID).
          */
         defaultSchema?: string | null;
+        /**
+         * Optional. The pipeline options which defines the pipeline type and path within the Git repository.
+         */
+        pipelineConfig?: Schema$PipelineConfig;
         /**
          * Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
          */
@@ -415,6 +449,10 @@ export declare namespace dataform_v1beta1 {
          * Output only. The version of `@dataform/core` that was used for compilation.
          */
         dataformCoreVersion?: string | null;
+        /**
+         * Output only. Metadata about the repository snapshot used by scheduled notebooks.
+         */
+        gcsRepositorySnapshotMetadata?: Schema$GcsRepositorySnapshotMetadata;
         /**
          * Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
          */
@@ -579,6 +617,24 @@ export declare namespace dataform_v1beta1 {
          */
         relationDescriptor?: Schema$RelationDescriptor;
     }
+    /**
+     * `DeleteBranch` request message.
+     */
+    export interface Schema$DeleteBranchRequest {
+        /**
+         * Required. The name of the branch in the Git repository to delete.
+         */
+        branch?: string | null;
+        /**
+         * 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.
+         */
+        force?: boolean | null;
+    }
+    /**
+     * `DeleteBranch` response message.
+     */
+    export interface Schema$DeleteBranchResponse {
+    }
     /**
      * Represents the delete file operation.
      */
@@ -676,6 +732,15 @@ export declare namespace dataform_v1beta1 {
          */
         title?: string | null;
     }
+    /**
+     * Response message for `FetchCurrentWorkspaceBranch` method.
+     */
+    export interface Schema$FetchCurrentWorkspaceBranchResponse {
+        /**
+         * The name of the current branch for the workspace.
+         */
+        branchName?: string | null;
+    }
     /**
      * `FetchFileDiff` response message.
      */
@@ -729,6 +794,19 @@ export declare namespace dataform_v1beta1 {
          */
         nextPageToken?: string | null;
     }
+    /**
+     * Response message for `FetchWorkspaceBranches` method.
+     */
+    export interface Schema$FetchWorkspaceBranchesResponse {
+        /**
+         * The branches in the workspace.
+         */
+        branches?: Schema$BranchMetadata[];
+        /**
+         * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+         */
+        nextPageToken?: string | null;
+    }
     /**
      * Represents a single file operation to the repository.
      */
@@ -814,6 +892,32 @@ export declare namespace dataform_v1beta1 {
          */
         repository?: Schema$Repository;
     }
+    /**
+     * Configures the destination for a repository snapshot.
+     */
+    export interface Schema$GcsRepositorySnapshotDestination {
+        /**
+         * Optional. The Google Cloud Storage destination to upload the repository snapshot to. Format: `gs://bucket-name/path/`.
+         */
+        repositorySnapshotUri?: string | null;
+    }
+    /**
+     * Metadata about a repository snapshot stored in Google Cloud Storage.
+     */
+    export interface Schema$GcsRepositorySnapshotMetadata {
+        /**
+         * Output only. The crc32c checksum of the repository snapshot, big-endian base64 encoded.
+         */
+        crc32cChecksum?: string | null;
+        /**
+         * Output only. The generation number of the Cloud Storage object. See https://cloud.google.com/storage/docs/metadata#generation-number.
+         */
+        generation?: string | null;
+        /**
+         * Output only. The Google Cloud Storage URI of the repository snapshot.
+         */
+        repositorySnapshotUri?: string | null;
+    }
     /**
      * Controls Git remote configuration for a repository.
      */
@@ -902,6 +1006,10 @@ export declare namespace dataform_v1beta1 {
      * `InstallNpmPackages` request message.
      */
     export interface Schema$InstallNpmPackagesRequest {
+        /**
+         * Optional. The pipeline options which defines the pipeline type and path within the Git repository.
+         */
+        pipelineConfig?: Schema$PipelineConfig;
     }
     /**
      * `InstallNpmPackages` response message.
@@ -1233,6 +1341,10 @@ export declare namespace dataform_v1beta1 {
          * Output only. The code contents of a Notebook to be run.
          */
         contents?: string | null;
+        /**
+         * Output only. The path to the notebook file in the repository.
+         */
+        filePath?: string | null;
         /**
          * Output only. The ID of the Gemini Enterprise Agent Platform job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.
          */
@@ -1250,6 +1362,10 @@ export declare namespace dataform_v1beta1 {
          * Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
          */
         gcsOutputBucket?: string | null;
+        /**
+         * Optional. The Google Cloud Storage destination to upload the snapshot to. For empty URI it defaults to the provided gcs_output_bucket. Format: `gs://bucket-name/path/`.
+         */
+        gcsRepositorySnapshotDestination?: Schema$GcsRepositorySnapshotDestination;
     }
     /**
      * This resource represents a long-running operation that is the result of a network API call.
@@ -1342,6 +1458,19 @@ export declare namespace dataform_v1beta1 {
          */
         tags?: string[] | null;
     }
+    /**
+     * Defines the pipeline type and path within the Git repository.
+     */
+    export interface Schema$PipelineConfig {
+        /**
+         * Required. The relative path within the Git repository where the pipeline is defined. For example, for a Dataform pipeline, it is a path to the folder where `workflow_settings.yaml` or `dataform.json` is located.
+         */
+        path?: string | null;
+        /**
+         * Required. The type of the pipeline.
+         */
+        pipelineType?: string | null;
+    }
     /**
      * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
      */
@@ -1661,7 +1790,7 @@ export declare namespace dataform_v1beta1 {
          */
         releaseCompilationResult?: string | null;
         /**
-         * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+         * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is `UTC`.
          */
         timeZone?: string | null;
     }
@@ -1923,6 +2052,24 @@ export declare namespace dataform_v1beta1 {
          */
         message?: string | null;
     }
+    /**
+     * `SyncWorkspaceRefs` request message.
+     */
+    export interface Schema$SyncWorkspaceRefsRequest {
+        /**
+         * 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
+         */
+        deepen?: number | null;
+        /**
+         * 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.
+         */
+        remoteBranchName?: string | null;
+    }
+    /**
+     * `SyncWorkspaceRefs` response message.
+     */
+    export interface Schema$SyncWorkspaceRefsResponse {
+    }
     /**
      * Represents a table update trigger configuration.
      */
@@ -2085,7 +2232,7 @@ export declare namespace dataform_v1beta1 {
          */
         releaseConfig?: string | null;
         /**
-         * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+         * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is `UTC`.
          */
         timeZone?: string | null;
         /**
@@ -2093,7 +2240,7 @@ export declare namespace dataform_v1beta1 {
          */
         updateTime?: string | null;
         /**
-         * Optional. Optional trigger configuration for this workflow. If present, the workflow will be triggered based on the specified triggers.
+         * Optional. Trigger configuration for this workflow. If present, the workflow will be triggered based on the specified triggers.
          */
         workflowTriggerConfig?: Schema$WorkflowTriggerConfig;
     }
@@ -2125,6 +2272,10 @@ export declare namespace dataform_v1beta1 {
          * Output only. The workflow invocation's name.
          */
         name?: string | null;
+        /**
+         * Output only. The pipeline options which defines the pipeline type and path within the Git repository.
+         */
+        pipelineConfig?: Schema$PipelineConfig;
         /**
          * Output only. Metadata indicating whether this resource is user-scoped. `WorkflowInvocation` resource is `user_scoped` only if it is sourced from a compilation result and the compilation result is user-scoped.
          */
@@ -2209,7 +2360,7 @@ export declare namespace dataform_v1beta1 {
          */
         maxWaitDuration?: string | null;
         /**
-         * Optional. Minimum duration between two consecutive executions. If not specified, the workflow will be executed every time trigger conditions are met and no ongoing workflow execution.
+         * Optional. Minimum duration between two consecutive executions. If not specified, the workflow will be executed every time trigger conditions are met and there is no ongoing workflow execution.
          */
         minExecutionDuration?: string | null;
         /**
@@ -2233,10 +2384,18 @@ export declare namespace dataform_v1beta1 {
          * Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.
          */
         dataEncryptionState?: Schema$DataEncryptionState;
+        /**
+         * 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.
+         */
+        depth?: number | null;
         /**
          * Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.
          */
         disableMoves?: boolean | null;
+        /**
+         * Immutable. Controls the enablement of branch checkout for the workspace. When set to True, the workspace will be allowed to checkout branches.
+         */
+        enableBranchManagement?: boolean | null;
         /**
          * 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.
          */
@@ -2245,10 +2404,18 @@ export declare namespace dataform_v1beta1 {
          * Identifier. The workspace's name.
          */
         name?: string | null;
+        /**
+         * 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.
+         */
+        originalBranch?: string | null;
         /**
          * Output only. Metadata indicating whether this resource is user-scoped. For `Workspace` resources, the `user_scoped` field is always `true`.
          */
         privateResourceMetadata?: Schema$PrivateResourceMetadata;
+        /**
+         * 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.
+         */
+        shallow?: boolean | null;
     }
     /**
      * 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.
@@ -5333,6 +5500,7 @@ export declare namespace dataform_v1beta1 {
          *         //   "createTime": "my_createTime",
          *         //   "dataEncryptionState": {},
          *         //   "dataformCoreVersion": "my_dataformCoreVersion",
+         *         //   "gcsRepositorySnapshotMetadata": {},
          *         //   "gitCommitish": "my_gitCommitish",
          *         //   "internalMetadata": "my_internalMetadata",
          *         //   "name": "my_name",
@@ -5352,6 +5520,7 @@ export declare namespace dataform_v1beta1 {
          *   //   "createTime": "my_createTime",
          *   //   "dataEncryptionState": {},
          *   //   "dataformCoreVersion": "my_dataformCoreVersion",
+         *   //   "gcsRepositorySnapshotMetadata": {},
          *   //   "gitCommitish": "my_gitCommitish",
          *   //   "internalMetadata": "my_internalMetadata",
          *   //   "name": "my_name",
@@ -5427,6 +5596,7 @@ export declare namespace dataform_v1beta1 {
          *   //   "createTime": "my_createTime",
          *   //   "dataEncryptionState": {},
          *   //   "dataformCoreVersion": "my_dataformCoreVersion",
+         *   //   "gcsRepositorySnapshotMetadata": {},
          *   //   "gitCommitish": "my_gitCommitish",
          *   //   "internalMetadata": "my_internalMetadata",
          *   //   "name": "my_name",
@@ -6677,6 +6847,7 @@ export declare namespace dataform_v1beta1 {
          *         //   "invocationConfig": {},
          *         //   "invocationTiming": {},
          *         //   "name": "my_name",
+         *         //   "pipelineConfig": {},
          *         //   "privateResourceMetadata": {},
          *         //   "resolvedCompilationResult": "my_resolvedCompilationResult",
          *         //   "state": "my_state",
@@ -6694,6 +6865,7 @@ export declare namespace dataform_v1beta1 {
          *   //   "invocationConfig": {},
          *   //   "invocationTiming": {},
          *   //   "name": "my_name",
+         *   //   "pipelineConfig": {},
          *   //   "privateResourceMetadata": {},
          *   //   "resolvedCompilationResult": "my_resolvedCompilationResult",
          *   //   "state": "my_state",
@@ -6829,6 +7001,7 @@ export declare namespace dataform_v1beta1 {
          *   //   "invocationConfig": {},
          *   //   "invocationTiming": {},
          *   //   "name": "my_name",
+         *   //   "pipelineConfig": {},
          *   //   "privateResourceMetadata": {},
          *   //   "resolvedCompilationResult": "my_resolvedCompilationResult",
          *   //   "state": "my_state",
@@ -7070,6 +7243,78 @@ export declare namespace dataform_v1beta1 {
     export class Resource$Projects$Locations$Repositories$Workspaces {
         context: APIRequestContext;
         constructor(context: APIRequestContext);
+        /**
+         * Checkout a branch in a Workspace.
+         * @example
+         * ```js
+         * // Before running the sample:
+         * // - Enable the API at:
+         * //   https://console.developers.google.com/apis/api/dataform.googleapis.com
+         * // - Login into gcloud by running:
+         * //   ```sh
+         * //   $ gcloud auth application-default login
+         * //   ```
+         * // - Install the npm module by running:
+         * //   ```sh
+         * //   $ npm install googleapis
+         * //   ```
+         *
+         * const {google} = require('googleapis');
+         * const dataform = google.dataform('v1beta1');
+         *
+         * async function main() {
+         *   const auth = new google.auth.GoogleAuth({
+         *     // Scopes can be specified either as an array or as a single, space-delimited string.
+         *     scopes: [
+         *       'https://www.googleapis.com/auth/bigquery',
+         *       'https://www.googleapis.com/auth/cloud-platform',
+         *     ],
+         *   });
+         *
+         *   // Acquire an auth client, and bind it to all future calls
+         *   const authClient = await auth.getClient();
+         *   google.options({auth: authClient});
+         *
+         *   // Do the magic
+         *   const res =
+         *     await dataform.projects.locations.repositories.workspaces.checkout({
+         *       // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         *       name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
+         *
+         *       // Request body metadata
+         *       requestBody: {
+         *         // request body parameters
+         *         // {
+         *         //   "branch": "my_branch",
+         *         //   "createIfNotExists": false,
+         *         //   "sourceBranch": "my_sourceBranch"
+         *         // }
+         *       },
+         *     });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {}
+         * }
+         *
+         * main().catch(e => {
+         *   console.error(e);
+         *   throw e;
+         * });
+         *
+         * ```
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        checkout(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        checkout(params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
+        checkout(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        checkout(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
+        checkout(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout, callback: BodyResponseCallback<Schema$Empty>): void;
+        checkout(callback: BodyResponseCallback<Schema$Empty>): void;
         /**
          * Applies a Git commit for uncommitted files in a Workspace.
          * @example
@@ -7187,10 +7432,14 @@ export declare namespace dataform_v1beta1 {
          *       // {
          *       //   "createTime": "my_createTime",
          *       //   "dataEncryptionState": {},
+         *       //   "depth": 0,
          *       //   "disableMoves": false,
+         *       //   "enableBranchManagement": false,
          *       //   "internalMetadata": "my_internalMetadata",
          *       //   "name": "my_name",
-         *       //   "privateResourceMetadata": {}
+         *       //   "originalBranch": "my_originalBranch",
+         *       //   "privateResourceMetadata": {},
+         *       //   "shallow": false
          *       // }
          *     },
          *   });
@@ -7200,10 +7449,14 @@ export declare namespace dataform_v1beta1 {
          *   // {
          *   //   "createTime": "my_createTime",
          *   //   "dataEncryptionState": {},
+         *   //   "depth": 0,
          *   //   "disableMoves": false,
+         *   //   "enableBranchManagement": false,
          *   //   "internalMetadata": "my_internalMetadata",
          *   //   "name": "my_name",
-         *   //   "privateResourceMetadata": {}
+         *   //   "originalBranch": "my_originalBranch",
+         *   //   "privateResourceMetadata": {},
+         *   //   "shallow": false
          *   // }
          * }
          *
@@ -7286,6 +7539,214 @@ export declare namespace dataform_v1beta1 {
         delete(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
         delete(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
         delete(callback: BodyResponseCallback<Schema$Empty>): void;
+        /**
+         * Deletes a branch in a Workspace.
+         * @example
+         * ```js
+         * // Before running the sample:
+         * // - Enable the API at:
+         * //   https://console.developers.google.com/apis/api/dataform.googleapis.com
+         * // - Login into gcloud by running:
+         * //   ```sh
+         * //   $ gcloud auth application-default login
+         * //   ```
+         * // - Install the npm module by running:
+         * //   ```sh
+         * //   $ npm install googleapis
+         * //   ```
+         *
+         * const {google} = require('googleapis');
+         * const dataform = google.dataform('v1beta1');
+         *
+         * async function main() {
+         *   const auth = new google.auth.GoogleAuth({
+         *     // Scopes can be specified either as an array or as a single, space-delimited string.
+         *     scopes: [
+         *       'https://www.googleapis.com/auth/bigquery',
+         *       'https://www.googleapis.com/auth/cloud-platform',
+         *     ],
+         *   });
+         *
+         *   // Acquire an auth client, and bind it to all future calls
+         *   const authClient = await auth.getClient();
+         *   google.options({auth: authClient});
+         *
+         *   // Do the magic
+         *   const res =
+         *     await dataform.projects.locations.repositories.workspaces.deleteBranch({
+         *       // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         *       name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
+         *
+         *       // Request body metadata
+         *       requestBody: {
+         *         // request body parameters
+         *         // {
+         *         //   "branch": "my_branch",
+         *         //   "force": false
+         *         // }
+         *       },
+         *     });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {}
+         * }
+         *
+         * main().catch(e => {
+         *   console.error(e);
+         *   throw e;
+         * });
+         *
+         * ```
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        deleteBranch(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        deleteBranch(params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$DeleteBranchResponse>>;
+        deleteBranch(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        deleteBranch(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, options: MethodOptions | BodyResponseCallback<Schema$DeleteBranchResponse>, callback: BodyResponseCallback<Schema$DeleteBranchResponse>): void;
+        deleteBranch(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch, callback: BodyResponseCallback<Schema$DeleteBranchResponse>): void;
+        deleteBranch(callback: BodyResponseCallback<Schema$DeleteBranchResponse>): void;
+        /**
+         * Fetches branches in a Workspace.
+         * @example
+         * ```js
+         * // Before running the sample:
+         * // - Enable the API at:
+         * //   https://console.developers.google.com/apis/api/dataform.googleapis.com
+         * // - Login into gcloud by running:
+         * //   ```sh
+         * //   $ gcloud auth application-default login
+         * //   ```
+         * // - Install the npm module by running:
+         * //   ```sh
+         * //   $ npm install googleapis
+         * //   ```
+         *
+         * const {google} = require('googleapis');
+         * const dataform = google.dataform('v1beta1');
+         *
+         * async function main() {
+         *   const auth = new google.auth.GoogleAuth({
+         *     // Scopes can be specified either as an array or as a single, space-delimited string.
+         *     scopes: [
+         *       'https://www.googleapis.com/auth/bigquery',
+         *       'https://www.googleapis.com/auth/cloud-platform',
+         *     ],
+         *   });
+         *
+         *   // Acquire an auth client, and bind it to all future calls
+         *   const authClient = await auth.getClient();
+         *   google.options({auth: authClient});
+         *
+         *   // Do the magic
+         *   const res =
+         *     await dataform.projects.locations.repositories.workspaces.fetchBranches({
+         *       // Optional. Filter for the returned list.
+         *       filter: 'placeholder-value',
+         *       // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         *       name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
+         *       // 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.
+         *       pageSize: 'placeholder-value',
+         *       // 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.
+         *       pageToken: 'placeholder-value',
+         *     });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "branches": [],
+         *   //   "nextPageToken": "my_nextPageToken"
+         *   // }
+         * }
+         *
+         * main().catch(e => {
+         *   console.error(e);
+         *   throw e;
+         * });
+         *
+         * ```
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        fetchBranches(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        fetchBranches(params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$FetchWorkspaceBranchesResponse>>;
+        fetchBranches(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        fetchBranches(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, options: MethodOptions | BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>, callback: BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>): void;
+        fetchBranches(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches, callback: BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>): void;
+        fetchBranches(callback: BodyResponseCallback<Schema$FetchWorkspaceBranchesResponse>): void;
+        /**
+         * Fetches the current branch of a Workspace.
+         * @example
+         * ```js
+         * // Before running the sample:
+         * // - Enable the API at:
+         * //   https://console.developers.google.com/apis/api/dataform.googleapis.com
+         * // - Login into gcloud by running:
+         * //   ```sh
+         * //   $ gcloud auth application-default login
+         * //   ```
+         * // - Install the npm module by running:
+         * //   ```sh
+         * //   $ npm install googleapis
+         * //   ```
+         *
+         * const {google} = require('googleapis');
+         * const dataform = google.dataform('v1beta1');
+         *
+         * async function main() {
+         *   const auth = new google.auth.GoogleAuth({
+         *     // Scopes can be specified either as an array or as a single, space-delimited string.
+         *     scopes: [
+         *       'https://www.googleapis.com/auth/bigquery',
+         *       'https://www.googleapis.com/auth/cloud-platform',
+         *     ],
+         *   });
+         *
+         *   // Acquire an auth client, and bind it to all future calls
+         *   const authClient = await auth.getClient();
+         *   google.options({auth: authClient});
+         *
+         *   // Do the magic
+         *   const res =
+         *     await dataform.projects.locations.repositories.workspaces.fetchCurrentBranch(
+         *       {
+         *         // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         *         name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
+         *       },
+         *     );
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "branchName": "my_branchName"
+         *   // }
+         * }
+         *
+         * main().catch(e => {
+         *   console.error(e);
+         *   throw e;
+         * });
+         *
+         * ```
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        fetchCurrentBranch(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        fetchCurrentBranch(params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$FetchCurrentWorkspaceBranchResponse>>;
+        fetchCurrentBranch(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        fetchCurrentBranch(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, options: MethodOptions | BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>, callback: BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>): void;
+        fetchCurrentBranch(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch, callback: BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>): void;
+        fetchCurrentBranch(callback: BodyResponseCallback<Schema$FetchCurrentWorkspaceBranchResponse>): void;
         /**
          * Fetches Git diff for an uncommitted file in a Workspace.
          * @example
@@ -7531,10 +7992,14 @@ export declare namespace dataform_v1beta1 {
          *   // {
          *   //   "createTime": "my_createTime",
          *   //   "dataEncryptionState": {},
+         *   //   "depth": 0,
          *   //   "disableMoves": false,
+         *   //   "enableBranchManagement": false,
          *   //   "internalMetadata": "my_internalMetadata",
          *   //   "name": "my_name",
-         *   //   "privateResourceMetadata": {}
+         *   //   "originalBranch": "my_originalBranch",
+         *   //   "privateResourceMetadata": {},
+         *   //   "shallow": false
          *   // }
          * }
          *
@@ -7668,7 +8133,9 @@ export declare namespace dataform_v1beta1 {
          *         // Request body metadata
          *         requestBody: {
          *           // request body parameters
-         *           // {}
+         *           // {
+         *           //   "pipelineConfig": {}
+         *           // }
          *         },
          *       },
          *     );
@@ -8628,6 +9095,79 @@ export declare namespace dataform_v1beta1 {
         setIamPolicy(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, options: MethodOptions | BodyResponseCallback<Schema$Policy>, callback: BodyResponseCallback<Schema$Policy>): void;
         setIamPolicy(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Setiampolicy, callback: BodyResponseCallback<Schema$Policy>): void;
         setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
+        /**
+         * Syncs the refs of a Workspace.
+         * @example
+         * ```js
+         * // Before running the sample:
+         * // - Enable the API at:
+         * //   https://console.developers.google.com/apis/api/dataform.googleapis.com
+         * // - Login into gcloud by running:
+         * //   ```sh
+         * //   $ gcloud auth application-default login
+         * //   ```
+         * // - Install the npm module by running:
+         * //   ```sh
+         * //   $ npm install googleapis
+         * //   ```
+         *
+         * const {google} = require('googleapis');
+         * const dataform = google.dataform('v1beta1');
+         *
+         * async function main() {
+         *   const auth = new google.auth.GoogleAuth({
+         *     // Scopes can be specified either as an array or as a single, space-delimited string.
+         *     scopes: [
+         *       'https://www.googleapis.com/auth/bigquery',
+         *       'https://www.googleapis.com/auth/cloud-platform',
+         *     ],
+         *   });
+         *
+         *   // Acquire an auth client, and bind it to all future calls
+         *   const authClient = await auth.getClient();
+         *   google.options({auth: authClient});
+         *
+         *   // Do the magic
+         *   const res =
+         *     await dataform.projects.locations.repositories.workspaces.syncWorkspaceRefs(
+         *       {
+         *         // Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         *         name: 'projects/my-project/locations/my-location/repositories/my-repositorie/workspaces/my-workspace',
+         *
+         *         // Request body metadata
+         *         requestBody: {
+         *           // request body parameters
+         *           // {
+         *           //   "deepen": 0,
+         *           //   "remoteBranchName": "my_remoteBranchName"
+         *           // }
+         *         },
+         *       },
+         *     );
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {}
+         * }
+         *
+         * main().catch(e => {
+         *   console.error(e);
+         *   throw e;
+         * });
+         *
+         * ```
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        syncWorkspaceRefs(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        syncWorkspaceRefs(params?: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$SyncWorkspaceRefsResponse>>;
+        syncWorkspaceRefs(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        syncWorkspaceRefs(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, options: MethodOptions | BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>, callback: BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>): void;
+        syncWorkspaceRefs(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs, callback: BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>): void;
+        syncWorkspaceRefs(callback: BodyResponseCallback<Schema$SyncWorkspaceRefsResponse>): void;
         /**
          * 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.
          * @example
@@ -8776,6 +9316,16 @@ export declare namespace dataform_v1beta1 {
         writeFile(params: Params$Resource$Projects$Locations$Repositories$Workspaces$Writefile, callback: BodyResponseCallback<Schema$WriteFileResponse>): void;
         writeFile(callback: BodyResponseCallback<Schema$WriteFileResponse>): void;
     }
+    export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Checkout extends StandardParameters {
+        /**
+         * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         */
+        name?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$CheckoutWorkspaceBranchRequest;
+    }
     export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Commit extends StandardParameters {
         /**
          * Required. The workspace's name.
@@ -8806,6 +9356,40 @@ export declare namespace dataform_v1beta1 {
          */
         name?: string;
     }
+    export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Deletebranch extends StandardParameters {
+        /**
+         * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         */
+        name?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$DeleteBranchRequest;
+    }
+    export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchbranches extends StandardParameters {
+        /**
+         * Optional. Filter for the returned list.
+         */
+        filter?: string;
+        /**
+         * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         */
+        name?: string;
+        /**
+         * 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.
+         */
+        pageSize?: number;
+        /**
+         * 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.
+         */
+        pageToken?: string;
+    }
+    export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchcurrentbranch extends StandardParameters {
+        /**
+         * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         */
+        name?: string;
+    }
     export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Fetchfilediff extends StandardParameters {
         /**
          * Required. The file's full path including filename, relative to the workspace root.
@@ -9024,6 +9608,16 @@ export declare namespace dataform_v1beta1 {
          */
         requestBody?: Schema$SetIamPolicyRequest;
     }
+    export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Syncworkspacerefs extends StandardParameters {
+        /**
+         * Required. The workspace resource name. Format: projects/{project\}/locations/{location\}/repositories/{repository\}/workspaces/{workspace\}
+         */
+        name?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$SyncWorkspaceRefsRequest;
+    }
     export interface Params$Resource$Projects$Locations$Repositories$Workspaces$Testiampermissions extends StandardParameters {
         /**
          * 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.