Dataform API (dataform:v1beta1)

Additions

Methods


• ▼ ▲ dataform.projects.locations.repositories.workspaces.checkout

  Scopes :

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

  Parameter Order : name

  Description : Checkout a branch in a Workspace.

  Parameters :

  name

  Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$

  Type : string

  Location : path

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

  Required : Yes

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:checkout

  HTTP Method : POST

  Path : v1beta1/{+name}:checkout

• ▼ ▲ dataform.projects.locations.repositories.workspaces.syncWorkspaceRefs

  Scopes :

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

  Parameter Order : name

  Description : Syncs the refs of a Workspace.

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:syncWorkspaceRefs

  Parameters :

  name

  Location : path

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

  Required : Yes

  Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$

  Type : string

  Path : v1beta1/{+name}:syncWorkspaceRefs

  HTTP Method : POST

• ▼ ▲ dataform.projects.locations.repositories.workspaces.fetchCurrentBranch

  HTTP Method : GET

  Path : v1beta1/{+name}:fetchCurrentBranch

  Scopes :

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

  Parameter Order : name

  Description : Fetches the current branch of a Workspace.

  Parameters :

  name

  Required : Yes

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

  Location : path

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchCurrentBranch

• ▼ ▲ dataform.projects.locations.repositories.workspaces.deleteBranch

  Scopes :

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

  Parameter Order : name

  Description : Deletes a branch in a Workspace.

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:deleteBranch

  Parameters :

  name

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

  Location : path

  Required : Yes

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$

  Path : v1beta1/{+name}:deleteBranch

  HTTP Method : POST

• ▼ ▲ dataform.projects.locations.repositories.workspaces.fetchBranches

  HTTP Method : GET

  Path : v1beta1/{+name}:fetchBranches

  Scopes :

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

  Parameter Order : name

  Description : Fetches branches in a Workspace.

  Parameters :

  name

  Type : string

  Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$

  Required : Yes

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

  Location : path

  filter

  Enum Descriptions :

  • Default value. This value is unused.
  • Returns local branches.
  • Returns remote branches.
  • Returns all branches.

  Location : query

  Description : Optional. Filter for the returned list.

  Enum :

  • BRANCH_FILTER_UNSPECIFIED
  • LOCAL_ONLY
  • REMOTE_ONLY
  • ALL

  Type : string

  pageSize

  Description : 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.

  Type : integer

  Location : query

  Format : int32

  pageToken

  Location : query

  Description : 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.

  Type : string

  Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchBranches