2025-10-20
▼ ▲ dataform.projects.locations.getConfig
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/config
HTTP Method : GET
Parameters :
name
Description : Required. The config name.
Pattern : ^projects/[^/]+/locations/[^/]+/config$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Get default config for a given project and location.
▼ ▲ dataform.projects.locations.updateConfig
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/config
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The config name.
Pattern : ^projects/[^/]+/locations/[^/]+/config$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Specifies the fields to be updated in the config.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Update default config for a given project and location. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
▼ ▲ dataform.projects.locations.list
Path : v1/{+name}/locations
Flat Path : v1/projects/{projectsId}/locations
HTTP Method : GET
Parameters :
name
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Location : path
Required : Yes
Type : string
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).
Location : query
Type : string
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Location : query
Type : integer
Format : int32
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
extraLocationTypes
Description : Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.
Location : query
Repeated : Yes
Type : string
Parameter Order : name
Scopes :
Description : Lists information about the supported locations for this service.
▼ ▲ dataform.projects.locations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
HTTP Method : GET
Parameters :
name
Description : Resource name for the location.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets information about a location.
▼ ▲ dataform.projects.locations.operations.list
Path : v1/{+name}/operations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
HTTP Method : GET
Parameters :
name
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
filter
Description : The standard list filter.
Location : query
Type : string
pageSize
Description : The standard list page size.
Location : query
Type : integer
Format : int32
pageToken
Description : The standard list page token.
Location : query
Type : string
returnPartialSuccess
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
Type : boolean
Parameter Order : name
Scopes :
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ dataform.projects.locations.operations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Description : The name of the operation resource.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ dataform.projects.locations.operations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
▼ ▲ dataform.projects.locations.operations.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : The name of the operation resource to be cancelled.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
▼ ▲ dataform.projects.locations.repositories.list
Path : v1/{+parent}/repositories
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories
HTTP Method : GET
Parameters :
parent
Description : Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
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.
Location : query
Type : integer
Format : int32
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`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
orderBy
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.
Location : query
Type : string
filter
Description : Optional. Filter for the returned list.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
▼ ▲ dataform.projects.locations.repositories.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}
HTTP Method : GET
Parameters :
name
Description : Required. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Fetches a single Repository.
▼ ▲ dataform.projects.locations.repositories.create
Path : v1/{+parent}/repositories
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories
HTTP Method : POST
Parameters :
parent
Description : Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
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
Parameter Order : parent
Scopes :
Description : Creates a new Repository in a given project and location.
▼ ▲ dataform.projects.locations.repositories.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Updates a single Repository. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
▼ ▲ dataform.projects.locations.repositories.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
force
Description : Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources. **Note:** *This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail.*.
Location : query
Type : boolean
Parameter Order : name
Scopes :
Description : Deletes a single Repository.
▼ ▲ dataform.projects.locations.repositories.commit
Path : v1/{+name}:commit
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:commit
HTTP Method : POST
Parameters :
name
Description : Required. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.
▼ ▲ dataform.projects.locations.repositories.readFile
Path : v1/{+name}:readFile
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:readFile
HTTP Method : GET
Parameters :
name
Description : Required. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
commitSha
Description : Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.
Location : query
Type : string
path
Description : Required. Full file path to read including filename, from repository root.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.
▼ ▲ dataform.projects.locations.repositories.queryDirectoryContents
Path : v1/{+name}:queryDirectoryContents
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:queryDirectoryContents
HTTP Method : GET
Parameters :
name
Description : Required. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
commitSha
Description : Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.
Location : query
Type : string
path
Description : Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.
Location : query
Type : string
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.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. Page token received from a previous `QueryRepositoryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryRepositoryDirectoryContents`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.
▼ ▲ dataform.projects.locations.repositories.fetchHistory
Path : v1/{+name}:fetchHistory
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchHistory
HTTP Method : GET
Parameters :
name
Description : Required. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. Page token received from a previous `FetchRepositoryHistory` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchRepositoryHistory`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.
▼ ▲ dataform.projects.locations.repositories.computeAccessTokenStatus
Path : v1/{+name}:computeAccessTokenStatus
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:computeAccessTokenStatus
HTTP Method : GET
Parameters :
name
Description : Required. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Computes a Repository's Git access token status.
▼ ▲ dataform.projects.locations.repositories.fetchRemoteBranches
Path : v1/{+name}:fetchRemoteBranches
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:fetchRemoteBranches
HTTP Method : GET
Parameters :
name
Description : Required. The repository's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Fetches a Repository's remote branches.
▼ ▲ dataform.projects.locations.repositories.getIamPolicy
Path : v1/{+resource}:getIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy
HTTP Method : GET
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes :
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ dataform.projects.locations.repositories.setIamPolicy
Path : v1/{+resource}:setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ dataform.projects.locations.repositories.testIamPermissions
Path : v1/{+resource}:testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ dataform.projects.locations.repositories.workspaces.list
Path : v1/{+parent}/workspaces
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces
HTTP Method : GET
Parameters :
parent
Description : Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
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.
Location : query
Type : integer
Format : int32
pageToken
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`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
orderBy
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.
Location : query
Type : string
filter
Description : Optional. Filter for the returned list.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists Workspaces in a given Repository.
▼ ▲ dataform.projects.locations.repositories.workspaces.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}
HTTP Method : GET
Parameters :
name
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Fetches a single Workspace.
▼ ▲ dataform.projects.locations.repositories.workspaces.create
Path : v1/{+parent}/workspaces
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces
HTTP Method : POST
Parameters :
parent
Description : Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
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
Parameter Order : parent
Scopes :
Description : Creates a new Workspace in a given Repository.
▼ ▲ dataform.projects.locations.repositories.workspaces.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The workspace resource's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a single Workspace.
▼ ▲ dataform.projects.locations.repositories.workspaces.installNpmPackages
Path : v1/{+workspace}:installNpmPackages
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:installNpmPackages
HTTP Method : POST
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : workspace
Scopes :
Description : Installs dependency NPM packages (inside a Workspace).
▼ ▲ dataform.projects.locations.repositories.workspaces.pull
Path : v1/{+name}:pull
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:pull
HTTP Method : POST
Parameters :
name
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Pulls Git commits from the Repository's remote into a Workspace.
▼ ▲ dataform.projects.locations.repositories.workspaces.push
Path : v1/{+name}:push
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:push
HTTP Method : POST
Parameters :
name
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Pushes Git commits from a Workspace to the Repository's remote.
▼ ▲ dataform.projects.locations.repositories.workspaces.fetchFileGitStatuses
Path : v1/{+name}:fetchFileGitStatuses
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileGitStatuses
HTTP Method : GET
Parameters :
name
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Fetches Git statuses for the files in a Workspace.
▼ ▲ dataform.projects.locations.repositories.workspaces.fetchGitAheadBehind
Path : v1/{+name}:fetchGitAheadBehind
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchGitAheadBehind
HTTP Method : GET
Parameters :
name
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
remoteBranch
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.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Fetches Git ahead/behind against a remote branch.
▼ ▲ dataform.projects.locations.repositories.workspaces.commit
Path : v1/{+name}:commit
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:commit
HTTP Method : POST
Parameters :
name
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Applies a Git commit for uncommitted files in a Workspace.
▼ ▲ dataform.projects.locations.repositories.workspaces.reset
Path : v1/{+name}:reset
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:reset
HTTP Method : POST
Parameters :
name
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Performs a Git reset for uncommitted files in a Workspace.
▼ ▲ dataform.projects.locations.repositories.workspaces.fetchFileDiff
Path : v1/{+workspace}:fetchFileDiff
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:fetchFileDiff
HTTP Method : GET
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
path
Description : Required. The file's full path including filename, relative to the workspace root.
Location : query
Type : string
Parameter Order : workspace
Scopes :
Description : Fetches Git diff for an uncommitted file in a Workspace.
▼ ▲ dataform.projects.locations.repositories.workspaces.queryDirectoryContents
Path : v1/{+workspace}:queryDirectoryContents
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:queryDirectoryContents
HTTP Method : GET
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
path
Description : Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
Location : query
Type : string
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.
Location : query
Type : integer
Format : int32
pageToken
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`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
Parameter Order : workspace
Scopes :
Description : Returns the contents of a given Workspace directory.
▼ ▲ dataform.projects.locations.repositories.workspaces.searchFiles
Path : v1/{+workspace}:searchFiles
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:searchFiles
HTTP Method : GET
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. Page token received from a previous `SearchFilesRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchFilesRequest`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the `path` field. See https://google.aip.dev/160 for details.
Location : query
Type : string
Parameter Order : workspace
Scopes :
Description : Finds the contents of a given Workspace directory by filter.
▼ ▲ dataform.projects.locations.repositories.workspaces.makeDirectory
Path : v1/{+workspace}:makeDirectory
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:makeDirectory
HTTP Method : POST
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : workspace
Scopes :
Description : Creates a directory inside a Workspace.
▼ ▲ dataform.projects.locations.repositories.workspaces.removeDirectory
Path : v1/{+workspace}:removeDirectory
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:removeDirectory
HTTP Method : POST
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : workspace
Scopes :
Description : Deletes a directory (inside a Workspace) and all of its contents.
▼ ▲ dataform.projects.locations.repositories.workspaces.moveDirectory
Path : v1/{+workspace}:moveDirectory
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveDirectory
HTTP Method : POST
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : workspace
Scopes :
Description : Moves a directory (inside a Workspace), and all of its contents, to a new location.
▼ ▲ dataform.projects.locations.repositories.workspaces.readFile
Path : v1/{+workspace}:readFile
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:readFile
HTTP Method : GET
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
path
Description : Required. The file's full path including filename, relative to the workspace root.
Location : query
Type : string
revision
Description : Optional. The Git revision of the file to return. If left empty, the current contents of `path` will be returned.
Location : query
Type : string
Parameter Order : workspace
Scopes :
Description : Returns the contents of a file (inside a Workspace).
▼ ▲ dataform.projects.locations.repositories.workspaces.removeFile
Path : v1/{+workspace}:removeFile
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:removeFile
HTTP Method : POST
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : workspace
Scopes :
Description : Deletes a file (inside a Workspace).
▼ ▲ dataform.projects.locations.repositories.workspaces.moveFile
Path : v1/{+workspace}:moveFile
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:moveFile
HTTP Method : POST
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : workspace
Scopes :
Description : Moves a file (inside a Workspace) to a new location.
▼ ▲ dataform.projects.locations.repositories.workspaces.writeFile
Path : v1/{+workspace}:writeFile
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:writeFile
HTTP Method : POST
Parameters :
workspace
Description : Required. The workspace's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : workspace
Scopes :
Description : Writes to a file (inside a Workspace).
▼ ▲ dataform.projects.locations.repositories.workspaces.getIamPolicy
Path : v1/{+resource}:getIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:getIamPolicy
HTTP Method : GET
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes :
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ dataform.projects.locations.repositories.workspaces.setIamPolicy
Path : v1/{+resource}:setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ dataform.projects.locations.repositories.workspaces.testIamPermissions
Path : v1/{+resource}:testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ dataform.projects.locations.repositories.releaseConfigs.list
Path : v1/{+parent}/releaseConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs
HTTP Method : GET
Parameters :
parent
Description : Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
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
Type : integer
Format : int32
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`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists ReleaseConfigs in a given Repository.
▼ ▲ dataform.projects.locations.repositories.releaseConfigs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. The release config's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Fetches a single ReleaseConfig.
▼ ▲ dataform.projects.locations.repositories.releaseConfigs.create
Path : v1/{+parent}/releaseConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs
HTTP Method : POST
Parameters :
parent
Description : Required. The repository in which to create the release config. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
releaseConfigId
Description : Required. The ID to use for the release config, which will become the final component of the release config's resource name.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Creates a new ReleaseConfig in a given Repository.
▼ ▲ dataform.projects.locations.repositories.releaseConfigs.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The release config's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Updates a single ReleaseConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
▼ ▲ dataform.projects.locations.repositories.releaseConfigs.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/releaseConfigs/{releaseConfigsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The release config's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/releaseConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a single ReleaseConfig.
▼ ▲ dataform.projects.locations.repositories.compilationResults.list
Path : v1/{+parent}/compilationResults
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults
HTTP Method : GET
Parameters :
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
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.
Location : query
Type : integer
Format : int32
pageToken
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`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
orderBy
Description : Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
Location : query
Type : string
filter
Description : Optional. Filter for the returned list.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists CompilationResults in a given Repository.
▼ ▲ dataform.projects.locations.repositories.compilationResults.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}
HTTP Method : GET
Parameters :
name
Description : Required. The compilation result's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/compilationResults/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Fetches a single CompilationResult.
▼ ▲ dataform.projects.locations.repositories.compilationResults.create
Path : v1/{+parent}/compilationResults
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults
HTTP Method : POST
Parameters :
parent
Description : Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates a new CompilationResult in a given project and location.
▼ ▲ dataform.projects.locations.repositories.compilationResults.query
Path : v1/{+name}:query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/compilationResults/{compilationResultsId}:query
HTTP Method : GET
Parameters :
name
Description : Required. The compilation result's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/compilationResults/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
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.
Location : query
Type : integer
Format : int32
pageToken
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`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Returns CompilationResultActions in a given CompilationResult.
▼ ▲ dataform.projects.locations.repositories.workflowConfigs.list
Path : v1/{+parent}/workflowConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs
HTTP Method : GET
Parameters :
parent
Description : Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists WorkflowConfigs in a given Repository.
▼ ▲ dataform.projects.locations.repositories.workflowConfigs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. The workflow config's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Fetches a single WorkflowConfig.
▼ ▲ dataform.projects.locations.repositories.workflowConfigs.create
Path : v1/{+parent}/workflowConfigs
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs
HTTP Method : POST
Parameters :
parent
Description : Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
workflowConfigId
Description : Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Creates a new WorkflowConfig in a given Repository.
▼ ▲ dataform.projects.locations.repositories.workflowConfigs.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The workflow config's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Updates a single WorkflowConfig. **Note:** *This method does not fully implement [AIP/134](https://google.aip.dev/134). The wildcard entry (\*) is treated as a bad request, and when the `field_mask` is omitted, the request is treated as a full update on all modifiable fields.*
▼ ▲ dataform.projects.locations.repositories.workflowConfigs.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowConfigs/{workflowConfigsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The workflow config's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowConfigs/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a single WorkflowConfig.
▼ ▲ dataform.projects.locations.repositories.workflowInvocations.list
Path : v1/{+parent}/workflowInvocations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations
HTTP Method : GET
Parameters :
parent
Description : Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
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.
Location : query
Type : integer
Format : int32
pageToken
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`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
orderBy
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.
Location : query
Type : string
filter
Description : Optional. Filter for the returned list.
Location : query
Type : string
Parameter Order : parent
Scopes :
Description : Lists WorkflowInvocations in a given Repository.
▼ ▲ dataform.projects.locations.repositories.workflowInvocations.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}
HTTP Method : GET
Parameters :
name
Description : Required. The workflow invocation resource's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Fetches a single WorkflowInvocation.
▼ ▲ dataform.projects.locations.repositories.workflowInvocations.create
Path : v1/{+parent}/workflowInvocations
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations
HTTP Method : POST
Parameters :
parent
Description : Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Creates a new WorkflowInvocation in a given Repository.
▼ ▲ dataform.projects.locations.repositories.workflowInvocations.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The workflow invocation resource's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Deletes a single WorkflowInvocation.
▼ ▲ dataform.projects.locations.repositories.workflowInvocations.cancel
Path : v1/{+name}:cancel
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:cancel
HTTP Method : POST
Parameters :
name
Description : Required. The workflow invocation resource's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes :
Description : Requests cancellation of a running WorkflowInvocation.
▼ ▲ dataform.projects.locations.repositories.workflowInvocations.query
Path : v1/{+name}:query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workflowInvocations/{workflowInvocationsId}:query
HTTP Method : GET
Parameters :
name
Description : Required. The workflow invocation's name.
Pattern : ^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workflowInvocations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
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.
Location : query
Type : integer
Format : int32
pageToken
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`, with the exception of `page_size`, must match the call that provided the page token.
Location : query
Type : string
Parameter Order : name
Scopes :
Description : Returns WorkflowInvocationActions in a given WorkflowInvocation.
▼ ▲ dataform.projects.locations.folders.getIamPolicy
Path : v1/{+resource}:getIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:getIamPolicy
HTTP Method : GET
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/folders/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes :
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ dataform.projects.locations.folders.setIamPolicy
Path : v1/{+resource}:setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/folders/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ dataform.projects.locations.folders.testIamPermissions
Path : v1/{+resource}:testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/folders/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ dataform.projects.locations.teamFolders.getIamPolicy
Path : v1/{+resource}:getIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:getIamPolicy
HTTP Method : GET
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$
Location : path
Required : Yes
Type : string
options.requestedPolicyVersion
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location : query
Type : integer
Format : int32
Parameter Order : resource
Scopes :
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ dataform.projects.locations.teamFolders.setIamPolicy
Path : v1/{+resource}:setIamPolicy
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:setIamPolicy
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ dataform.projects.locations.teamFolders.testIamPermissions
Path : v1/{+resource}:testIamPermissions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:testIamPermissions
HTTP Method : POST
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern : ^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : resource
Scopes :
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.