Method: projects.locations.repositories.workspaces.syncWorkspaceRefs

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization scopes
• IAM Permissions
• Try it!

Syncs the refs of a workspace.

HTTP request

Choose a location:

global africa-south1 asia-east1 asia-east2 asia-northeast1 asia-northeast2 asia-northeast3 asia-south1 asia-south2 asia-southeast1 asia-southeast2 australia-southeast1 australia-southeast2 europe-central2 europe-north1 europe-southwest1 europe-west1 europe-west10 europe-west12 europe-west2 europe-west3 europe-west4 europe-west6 europe-west8 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast1 northamerica-northeast2 southamerica-east1 southamerica-west1 us-central1 us-east1 us-east4 us-east5 us-south1 us-west1 us-west2 us-west3 us-west4

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

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. The workspace resource name. Format: projects/{project}/locations/{location}/repositories/{repository}/workspaces/{workspace}

Request body

The request body contains data with the following structure:

JSON representation
{ "remoteBranchName": string, "deepen": integer }

Fields
remoteBranchName	string Optional. The name of the branch in the Git remote for which the refs are fetched. If left unset, all remote branches are fetched.
deepen	integer 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

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.syncRefs

For more information, see the IAM documentation.