Method: projects.locations.repositories.workspaces.pull

Pulls Git commits from the Repository's remote into a Workspace.

HTTP request

POST https://dataform.googleapis.com/v1beta1/{name=projects/*/locations/*/repositories/*/workspaces/*}:pull

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The workspace's name.

Authorization requires the following IAM permission on the specified resource name:

  • dataform.workspaces.pull

Request body

The request body contains data with the following structure:

JSON representation 
{
  "remoteBranch": string,
  "author": {
    object (CommitAuthor)
  }
}
Fields
remoteBranch

string

Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.
author

object (CommitAuthor)

Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace.

Response body

If successful, the response body is empty.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/bigquery

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • dataform.workspaces.pull

For more information, see the IAM documentation.