Dataform API (dataform:v1beta1)

2022-12-20

43 new methods | New API

Additions

    Methods
  • dataform.projects.locations.repositories.patch

      Description: Updates a single Repository.

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Parameter Order: name

      HTTP Method: PATCH

      Parameters:

        updateMask

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

          Location: query

          Format: google-fieldmask

          Type: string

        name

          Type: string

          Location: path

          Description: Output only. The repository's name.

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

          Required: Yes

      Path: v1beta1/{+name}

  • dataform.projects.locations.repositories.list

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

      Description: Lists Repositories in a given project and location.

      HTTP Method: GET

      Path: v1beta1/{+parent}/repositories

      Parameters:

        filter

          Location: query

          Description: Optional. Filter for the returned list.

          Type: string

        pageSize

          Format: int32

          Location: query

          Type: integer

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

        parent

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

          Required: Yes

          Location: path

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

          Type: string

        orderBy

          Type: string

          Location: query

          Description: Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.

        pageToken

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

          Type: string

          Location: query

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

  • dataform.projects.locations.repositories.delete

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

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

      HTTP Method: DELETE

      Path: v1beta1/{+name}

      Description: Deletes a single Repository.

      Parameters:

        name

          Location: path

          Required: Yes

          Description: Required. The repository's name.

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

          Type: string

        force

          Type: boolean

          Location: query

          Description: If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)

  • dataform.projects.locations.repositories.get

      Parameters:

        name

          Required: Yes

          Location: path

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

          Type: string

          Description: Required. The repository's name.

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

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Description: Fetches a single Repository.

      Path: v1beta1/{+name}

  • dataform.projects.locations.repositories.create

      Parameter Order: parent

      HTTP Method: POST

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

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

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+parent}/repositories

      Parameters:

        parent

          Required: Yes

          Location: path

          Type: string

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

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

        repositoryId

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

          Location: query

          Type: string

  • dataform.projects.locations.repositories.fetchRemoteBranches

      Description: Fetches a Repository's remote branches.

      Parameters:

        name

          Type: string

          Description: Required. The repository's name.

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

          Required: Yes

          Location: path

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Path: v1beta1/{+name}:fetchRemoteBranches

      HTTP Method: GET

  • dataform.projects.locations.repositories.workspaces.moveDirectory

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Parameters:

        workspace

          Required: Yes

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

          Location: path

          Type: string

          Description: Required. The workspace's name.

      HTTP Method: POST

      Description: Moves a directory (inside a Workspace), and all of its contents, to a new location.

      Path: v1beta1/{+workspace}:moveDirectory

      Parameter Order: workspace

  • dataform.projects.locations.repositories.workspaces.get

      Parameters:

        name

          Type: string

          Description: Required. The workspace's name.

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

          Required: Yes

          Location: path

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+name}

      HTTP Method: GET

      Description: Fetches a single Workspace.

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

      Parameter Order: name

  • dataform.projects.locations.repositories.workspaces.fetchFileDiff

      Parameter Order: workspace

      Path: v1beta1/{+workspace}:fetchFileDiff

      HTTP Method: GET

      Parameters:

        workspace

          Location: path

          Type: string

          Description: Required. The workspace's name.

          Required: Yes

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

        path

          Description: Required. The file's full path including filename, relative to the workspace root.

          Type: string

          Location: query

      Description: Fetches Git diff for an uncommitted file in a Workspace.

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

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The workspace's name.

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

          Location: path

          Type: string

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Path: v1beta1/{+name}:fetchFileGitStatuses

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

      Description: Fetches Git statuses for the files in a Workspace.

  • dataform.projects.locations.repositories.workspaces.moveFile

      Path: v1beta1/{+workspace}:moveFile

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

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

      Parameter Order: workspace

      Description: Moves a file (inside a Workspace) to a new location.

      Parameters:

        workspace

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

          Required: Yes

          Type: string

          Location: path

          Description: Required. The workspace's name.

  • dataform.projects.locations.repositories.workspaces.removeDirectory

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

      Description: Deletes a directory (inside a Workspace) and all of its contents.

      HTTP Method: POST

      Parameters:

        workspace

          Required: Yes

          Location: path

          Type: string

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

          Description: Required. The workspace's name.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+workspace}:removeDirectory

      Parameter Order: workspace

  • dataform.projects.locations.repositories.workspaces.list

      Parameters:

        orderBy

          Location: query

          Description: Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.

          Type: string

        filter

          Type: string

          Description: Optional. Filter for the returned list.

          Location: query

        parent

          Location: path

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

          Description: Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`.

          Required: Yes

          Type: string

        pageToken

          Type: string

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

          Location: query

        pageSize

          Location: query

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

          Format: int32

          Type: integer

      Description: Lists Workspaces in a given Repository.

      Path: v1beta1/{+parent}/workspaces

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

      Parameter Order: parent

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • dataform.projects.locations.repositories.workspaces.delete

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

      HTTP Method: DELETE

      Description: Deletes a single Workspace.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Parameters:

        name

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

          Description: Required. The workspace resource's name.

          Location: path

          Type: string

          Required: Yes

      Path: v1beta1/{+name}

  • dataform.projects.locations.repositories.workspaces.installNpmPackages

      Parameter Order: workspace

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+workspace}:installNpmPackages

      HTTP Method: POST

      Parameters:

        workspace

          Location: path

          Description: Required. The workspace's name.

          Required: Yes

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

          Type: string

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

      Description: Installs dependency NPM packages (inside a Workspace).

  • dataform.projects.locations.repositories.workspaces.create

      Path: v1beta1/{+parent}/workspaces

      Description: Creates a new Workspace in a given Repository.

      Parameter Order: parent

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

      HTTP Method: POST

      Parameters:

        workspaceId

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

          Location: query

          Type: string

        parent

          Location: path

          Type: string

          Required: Yes

          Description: Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.

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

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • dataform.projects.locations.repositories.workspaces.push

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

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

          Required: Yes

          Location: path

          Description: Required. The workspace's name.

          Type: string

      Description: Pushes Git commits from a Workspace to the Repository's remote.

      Path: v1beta1/{+name}:push

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

      Parameter Order: name

  • dataform.projects.locations.repositories.workspaces.makeDirectory

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

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

      Description: Creates a directory inside a Workspace.

      Path: v1beta1/{+workspace}:makeDirectory

      Parameter Order: workspace

      Parameters:

        workspace

          Description: Required. The workspace's name.

          Required: Yes

          Location: path

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

          Type: string

  • dataform.projects.locations.repositories.workspaces.removeFile

      HTTP Method: POST

      Parameter Order: workspace

      Path: v1beta1/{+workspace}:removeFile

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

      Parameters:

        workspace

          Description: Required. The workspace's name.

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

          Location: path

          Type: string

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes a file (inside a Workspace).

  • dataform.projects.locations.repositories.workspaces.readFile

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

      Description: Returns the contents of a file (inside a Workspace).

      Parameters:

        workspace

          Description: Required. The workspace's name.

          Location: path

          Required: Yes

          Type: string

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

        path

          Type: string

          Description: Required. The file's full path including filename, relative to the workspace root.

          Location: query

      Path: v1beta1/{+workspace}:readFile

      HTTP Method: GET

      Parameter Order: workspace

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • dataform.projects.locations.repositories.workspaces.commit

      Parameters:

        name

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

          Location: path

          Required: Yes

          Type: string

          Description: Required. The workspace's name.

      Parameter Order: name

      Description: Applies a Git commit for uncommitted files in a Workspace.

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

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+name}:commit

      HTTP Method: POST

  • dataform.projects.locations.repositories.workspaces.queryDirectoryContents

      Description: Returns the contents of a given Workspace directory.

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Parameters:

        path

          Type: string

          Location: query

          Description: Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.

        workspace

          Required: Yes

          Description: Required. The workspace's name.

          Location: path

          Type: string

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

        pageToken

          Location: query

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

          Type: string

        pageSize

          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.

          Type: integer

      Path: v1beta1/{+workspace}:queryDirectoryContents

      HTTP Method: GET

      Parameter Order: workspace

  • dataform.projects.locations.repositories.workspaces.reset

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

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

          Required: Yes

          Location: path

          Description: Required. The workspace's name.

          Type: string

      Path: v1beta1/{+name}:reset

      Description: Performs a Git reset for uncommitted files in a Workspace.

      HTTP Method: POST

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

  • dataform.projects.locations.repositories.workspaces.writeFile

      Parameters:

        workspace

          Description: Required. The workspace's name.

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

          Type: string

          Location: path

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+workspace}:writeFile

      Description: Writes to a file (inside a Workspace).

      Parameter Order: workspace

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

      HTTP Method: POST

  • dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind

      HTTP Method: GET

      Parameter Order: name

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

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Fetches Git ahead/behind against a remote branch.

      Parameters:

        name

          Type: string

          Location: path

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

          Required: Yes

          Description: Required. The workspace's name.

        remoteBranch

          Location: query

          Type: string

          Description: Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.

      Path: v1beta1/{+name}:fetchGitAheadBehind

  • dataform.projects.locations.repositories.workspaces.pull

      HTTP Method: POST

      Path: v1beta1/{+name}:pull

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Parameters:

        name

          Location: path

          Description: Required. The workspace's name.

          Required: Yes

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

          Type: string

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

  • dataform.projects.locations.repositories.compilationResults.list

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: parent

      Description: Lists CompilationResults in a given Repository.

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

      Path: v1beta1/{+parent}/compilationResults

      Parameters:

        pageToken

          Type: string

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

          Location: query

        parent

          Description: Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`.

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Location: query

          Format: int32

          Type: integer

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

      HTTP Method: GET

  • dataform.projects.locations.repositories.compilationResults.create

      Path: v1beta1/{+parent}/compilationResults

      Parameter Order: parent

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

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

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

      Parameters:

        parent

          Location: path

          Required: Yes

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

          Type: string

          Description: Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`.

  • dataform.projects.locations.repositories.compilationResults.query

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Description: Returns CompilationResultActions in a given CompilationResult.

      Path: v1beta1/{+name}:query

      Parameters:

        filter

          Type: string

          Description: Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.

          Location: query

        pageSize

          Location: query

          Format: int32

          Type: integer

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

        pageToken

          Type: string

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

          Location: query

        name

          Description: Required. The compilation result's name.

          Location: path

          Required: Yes

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

          Type: string

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}:query

      Parameter Order: name

  • dataform.projects.locations.repositories.compilationResults.get

      Parameter Order: name

      Parameters:

        name

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

          Description: Required. The compilation result's name.

          Location: path

          Type: string

          Required: Yes

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

      Path: v1beta1/{+name}

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Fetches a single CompilationResult.

  • dataform.projects.locations.repositories.workflowInvocations.query

      Description: Returns WorkflowInvocationActions in a given WorkflowInvocation.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:query

      Path: v1beta1/{+name}:query

      Parameters:

        pageSize

          Type: integer

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

          Format: int32

          Location: query

        name

          Type: string

          Required: Yes

          Description: Required. The workflow invocation's name.

          Location: path

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

        pageToken

          Location: query

          Type: string

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

      Parameter Order: name

      HTTP Method: GET

  • dataform.projects.locations.repositories.workflowInvocations.cancel

      Parameters:

        name

          Required: Yes

          Description: Required. The workflow invocation resource's name.

          Type: string

          Location: path

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

      Description: Requests cancellation of a running WorkflowInvocation.

      Parameter Order: name

      Path: v1beta1/{+name}:cancel

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Flat Path: v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:cancel

      HTTP Method: POST

  • dataform.projects.locations.repositories.workflowInvocations.list

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists WorkflowInvocations in a given Repository.

      HTTP Method: GET

      Parameters:

        orderBy

          Location: query

          Description: Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.

          Type: string

        pageSize

          Type: integer

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

          Format: int32

          Location: query

        pageToken

          Location: query

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

          Type: string

        filter

          Description: Optional. Filter for the returned list.

          Type: string

          Location: query

        parent

          Description: Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`.

          Required: Yes

          Location: path

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

          Type: string

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

      Path: v1beta1/{+parent}/workflowInvocations

  • dataform.projects.locations.repositories.workflowInvocations.create

      Path: v1beta1/{+parent}/workflowInvocations

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Creates a new WorkflowInvocation in a given Repository.

      Parameters:

        parent

          Required: Yes

          Description: Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`.

          Location: path

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

          Type: string

      HTTP Method: POST

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

  • dataform.projects.locations.repositories.workflowInvocations.delete

      HTTP Method: DELETE

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Path: v1beta1/{+name}

      Parameters:

        name

          Required: Yes

          Location: path

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

          Description: Required. The workflow invocation resource's name.

          Type: string

      Description: Deletes a single WorkflowInvocation.

      Parameter Order: name

  • dataform.projects.locations.repositories.workflowInvocations.get

      HTTP Method: GET

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+name}

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

      Description: Fetches a single WorkflowInvocation.

      Parameters:

        name

          Description: Required. The workflow invocation resource's name.

          Type: string

          Required: Yes

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

          Location: path

      Parameter Order: name

  • dataform.projects.locations.repositories.releaseConfigs.get

      Scopes: https://www.googleapis.com/auth/cloud-platform

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

      Parameter Order: name

      HTTP Method: GET

      Description: Fetches a single ReleaseConfig.

      Parameters:

        name

          Required: Yes

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

          Description: Required. The release config's name.

          Type: string

          Location: path

      Path: v1beta1/{+name}

  • dataform.projects.locations.repositories.releaseConfigs.list

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

      Parameters:

        parent

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

          Location: path

          Type: string

          Required: Yes

          Description: Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`.

        pageSize

          Format: int32

          Type: integer

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

          Location: query

        pageToken

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

          Type: string

          Location: query

      Path: v1beta1/{+parent}/releaseConfigs

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: GET

      Parameter Order: parent

      Description: Lists ReleaseConfigs in a given Repository.

  • dataform.projects.locations.repositories.releaseConfigs.delete

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

      HTTP Method: DELETE

      Parameters:

        name

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

          Description: Required. The release config's name.

          Location: path

          Type: string

          Required: Yes

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes a single ReleaseConfig.

      Path: v1beta1/{+name}

      Parameter Order: name

  • dataform.projects.locations.repositories.releaseConfigs.create

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        parent

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

          Location: path

          Type: string

          Description: Required. The repository in which to create the release config. Must be in the format `projects/*/locations/*/repositories/*`.

          Required: Yes

        releaseConfigId

          Location: query

          Type: string

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

      Path: v1beta1/{+parent}/releaseConfigs

      Description: Creates a new ReleaseConfig in a given Repository.

      HTTP Method: POST

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

      Parameter Order: parent

  • dataform.projects.locations.repositories.releaseConfigs.patch

      Parameters:

        updateMask

          Type: string

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

          Location: query

          Format: google-fieldmask

        name

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

          Type: string

          Location: path

          Required: Yes

          Description: Output only. The release config's name.

      Description: Updates a single ReleaseConfig.

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

      Path: v1beta1/{+name}

      Parameter Order: name

      HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • dataform.projects.locations.list

      Path: v1beta1/{+name}/locations

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

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists information about the supported locations for this service.

      Parameter Order: name

      HTTP Method: GET

      Parameters:

        pageToken

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Location: query

          Type: string

        name

          Description: The resource that owns the locations collection, if applicable.

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          Type: string

        includeUnrevealedLocations

          Type: boolean

          Location: query

          Description: If true, the returned list will include locations which are not yet revealed.

        filter

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Type: string

          Location: query

        pageSize

          Type: integer

          Format: int32

          Location: query

          Description: The maximum number of results to return. If not set, the service selects a default.

  • dataform.projects.locations.get

      Parameters:

        name

          Location: path

          Type: string

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

          Required: Yes

          Description: Resource name for the location.

      Description: Gets information about a location.

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

      HTTP Method: GET

      Parameter Order: name

      Path: v1beta1/{+name}

      Scopes: https://www.googleapis.com/auth/cloud-platform