Dataform API (dataform:v1beta1)

2026-01-13

14 new methods

Additions

    Methods
  • dataform.projects.locations.queryUserRootContents

      Scopes :

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

        orderBy

          Type : string

          Description : Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"`

          Location : query

        filter

          Type : string

          Location : query

          Description : Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`

        pageToken

          Location : query

          Description : Optional. Page token received from a previous `QueryUserRootContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryUserRootFolderContents`, with the exception of `page_size`, must match the call that provided the page token.

          Type : string

        location

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

          Description : Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

          Required : Yes

          Type : string

          Location : path

        pageSize

          Type : integer

          Location : query

          Format : int32

          Description : Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}:queryUserRootContents

      Path : v1beta1/{+location}:queryUserRootContents

      HTTP Method : GET

      Description : Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.

      Parameter Order : location

  • dataform.projects.locations.folders.patch

      HTTP Method : PATCH

      Path : v1beta1/{+name}

      Description : Updates a single Folder.

      Parameters :

        name

          Type : string

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/folders/[^/]+$

          Description : Identifier. The Folder's name.

          Location : path

        updateMask

          Type : string

          Format : google-fieldmask

          Location : query

          Description : Optional. Specifies the fields to be updated in the Folder. If left unset, all fields that can be updated, will be updated. A few fields cannot be updated and will be ignored if specified in the update_mask (e.g. parent_name, team_folder_name).

      Scopes :

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}

      Parameter Order : name

  • dataform.projects.locations.folders.queryFolderContents

      Description : Returns the contents of a given Folder.

      Scopes :

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

        filter

          Description : Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`

          Location : query

          Type : string

        pageToken

          Type : string

          Description : Optional. Page token received from a previous `QueryFolderContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryFolderContents`, with the exception of `page_size`, must match the call that provided the page token.

          Location : query

        orderBy

          Type : string

          Description : Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"`

          Location : query

        pageSize

          Location : query

          Description : Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

          Format : int32

          Type : integer

        folder

          Location : path

          Required : Yes

          Description : Required. Name of the folder whose contents to list. Format: projects/*/locations/*/folders/*

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/folders/[^/]+$

      Path : v1beta1/{+folder}:queryFolderContents

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:queryFolderContents

      Parameter Order : folder

      HTTP Method : GET

  • dataform.projects.locations.folders.get

      Path : v1beta1/{+name}

      Description : Fetches a single Folder.

      Parameter Order : name

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

          Location : path

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/folders/[^/]+$

          Description : Required. The Folder's name.

      Scopes :

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
  • dataform.projects.locations.folders.create

      HTTP Method : POST

      Description : Creates a new Folder in a given project and location.

      Parameter Order : parent

      Path : v1beta1/{+parent}/folders

      Scopes :

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

        folderId

          Description : The ID to use for the Folder, which will become the final component of the Folder's resource name.

          Type : string

          Location : query

        parent

          Type : string

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

          Required : Yes

          Location : path

          Description : Required. The location in which to create the Folder. Must be in the format `projects/*/locations/*`.

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/folders

  • dataform.projects.locations.folders.move

      Parameter Order : name

      Description : Moves a Folder to a new Folder, TeamFolder, or the root location.

      Scopes :

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

      Path : v1beta1/{+name}:move

      Parameters :

        name

          Description : Required. The full resource name of the Folder to move.

          Pattern : ^projects/[^/]+/locations/[^/]+/folders/[^/]+$

          Type : string

          Required : Yes

          Location : path

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:move

  • dataform.projects.locations.folders.delete

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}

      HTTP Method : DELETE

      Path : v1beta1/{+name}

      Parameter Order : name

      Parameters :

        name

          Description : Required. The Folder's name.

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/folders/[^/]+$

          Required : Yes

          Location : path

      Scopes :

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Deletes a single Folder.

  • dataform.projects.locations.teamFolders.search

      Path : v1beta1/{+location}/teamFolders:search

      Parameter Order : location

      Scopes :

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

      Parameters :

        filter

          Type : string

          Location : query

          Description : Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`

        location

          Location : path

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

          Description : Required. Location in which to query TeamFolders. Format: `projects/*/locations/*`.

          Type : string

          Required : Yes

        pageSize

          Format : int32

          Type : integer

          Location : query

          Description : Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

        orderBy

          Type : string

          Description : Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"`

          Location : query

        pageToken

          Description : Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token.

          Location : query

          Type : string

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders:search

      Description : Returns all TeamFolders in a given location that the caller has access to and match the provided filter.

  • dataform.projects.locations.teamFolders.get

      HTTP Method : GET

      Parameter Order : name

      Path : v1beta1/{+name}

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}

      Parameters :

        name

          Type : string

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$

          Description : Required. The TeamFolder's name.

          Location : path

      Scopes :

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Fetches a single TeamFolder.

  • dataform.projects.locations.teamFolders.delete

      Parameters :

        name

          Required : Yes

          Description : Required. The TeamFolder's name.

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$

          Location : path

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}

      Parameter Order : name

      Path : v1beta1/{+name}

      HTTP Method : DELETE

      Scopes :

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Deletes a single TeamFolder.

  • dataform.projects.locations.teamFolders.patch

      Description : Updates a single TeamFolder.

      Path : v1beta1/{+name}

      HTTP Method : PATCH

      Scopes :

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

        name

          Type : string

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$

          Description : Identifier. The TeamFolder's name.

        updateMask

          Format : google-fieldmask

          Location : query

          Description : Optional. Specifies the fields to be updated in the Folder. If left unset, all fields will be updated.

          Type : string

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}

      Parameter Order : name

  • dataform.projects.locations.teamFolders.create

      Description : Creates a new TeamFolder in a given project and location.

      Scopes :

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

        parent

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

          Type : string

          Location : path

          Description : Required. The location in which to create the TeamFolder. Must be in the format `projects/*/locations/*`.

          Required : Yes

        teamFolderId

          Description : The ID to use for the TeamFolder, which will become the final component of the TeamFolder's resource name.

          Location : query

          Type : string

      Parameter Order : parent

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders

      HTTP Method : POST

      Path : v1beta1/{+parent}/teamFolders

  • dataform.projects.locations.teamFolders.queryContents

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Returns the contents of a given TeamFolder.

      Path : v1beta1/{+teamFolder}:queryContents

      Parameters :

        pageSize

          Description : Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

          Format : int32

          Type : integer

          Location : query

        teamFolder

          Pattern : ^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$

          Required : Yes

          Description : Required. Name of the team_folder whose contents to list. Format: `projects/*/locations/*/teamFolders/*`.

          Location : path

          Type : string

        orderBy

          Description : Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by `order_by` in ascending order. Supported keywords: `display_name` (default), `create_time`, last_modified_time. Examples: - `orderBy="display_name"` - `orderBy="display_name desc"`

          Type : string

          Location : query

        filter

          Description : Optional. Optional filtering for the returned list. Filtering is currently only supported on the `display_name` field. Example: - `filter="display_name="MyFolder""`

          Type : string

          Location : query

        pageToken

          Description : Optional. Page token received from a previous `QueryTeamFolderContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryTeamFolderContents`, with the exception of `page_size`, must match the call that provided the page token.

          Type : string

          Location : query

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:queryContents

      Parameter Order : teamFolder

  • dataform.projects.locations.repositories.move

      Flat Path : v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:move

      Parameter Order : name

      Path : v1beta1/{+name}:move

      Parameters :

        name

          Description : Required. The full resource name of the repository to move.

          Location : path

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

          Required : Yes

          Type : string

      Scopes :

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

      Description : Moves a Repository to a new location.