Dataform v1beta1 API - Class Dataform.DataformBase (1.0.0-beta11)

[BindServiceMethod(typeof(Dataform), "BindService")]
public abstract class Dataform.DataformBase

Reference documentation and code samples for the Dataform v1beta1 API class Dataform.DataformBase.

Base class for server-side implementations of Dataform

Inheritance

object > Dataform.DataformBase

Namespace

Google.Cloud.Dataform.V1Beta1

Assembly

Google.Cloud.Dataform.V1Beta1.dll

Methods

CancelWorkflowInvocation(CancelWorkflowInvocationRequest, ServerCallContext)

public virtual Task<CancelWorkflowInvocationResponse> CancelWorkflowInvocation(CancelWorkflowInvocationRequest request, ServerCallContext context)

Requests cancellation of a running WorkflowInvocation.

Parameters
Name Description
request CancelWorkflowInvocationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskCancelWorkflowInvocationResponse

The response to send back to the client (wrapped by a task).

CommitRepositoryChanges(CommitRepositoryChangesRequest, ServerCallContext)

public virtual Task<CommitRepositoryChangesResponse> CommitRepositoryChanges(CommitRepositoryChangesRequest request, ServerCallContext context)

Applies a Git commit to a Repository. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request CommitRepositoryChangesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskCommitRepositoryChangesResponse

The response to send back to the client (wrapped by a task).

CommitWorkspaceChanges(CommitWorkspaceChangesRequest, ServerCallContext)

public virtual Task<CommitWorkspaceChangesResponse> CommitWorkspaceChanges(CommitWorkspaceChangesRequest request, ServerCallContext context)

Applies a Git commit for uncommitted files in a Workspace.

Parameters
Name Description
request CommitWorkspaceChangesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskCommitWorkspaceChangesResponse

The response to send back to the client (wrapped by a task).

ComputeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest, ServerCallContext)

public virtual Task<ComputeRepositoryAccessTokenStatusResponse> ComputeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request, ServerCallContext context)

Computes a Repository's Git access token status.

Parameters
Name Description
request ComputeRepositoryAccessTokenStatusRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskComputeRepositoryAccessTokenStatusResponse

The response to send back to the client (wrapped by a task).

CreateCompilationResult(CreateCompilationResultRequest, ServerCallContext)

public virtual Task<CompilationResult> CreateCompilationResult(CreateCompilationResultRequest request, ServerCallContext context)

Creates a new CompilationResult in a given project and location.

Parameters
Name Description
request CreateCompilationResultRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskCompilationResult

The response to send back to the client (wrapped by a task).

CreateFolder(CreateFolderRequest, ServerCallContext)

public virtual Task<Folder> CreateFolder(CreateFolderRequest request, ServerCallContext context)

Creates a new Folder in a given project and location.

Parameters
Name Description
request CreateFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFolder

The response to send back to the client (wrapped by a task).

CreateReleaseConfig(CreateReleaseConfigRequest, ServerCallContext)

public virtual Task<ReleaseConfig> CreateReleaseConfig(CreateReleaseConfigRequest request, ServerCallContext context)

Creates a new ReleaseConfig in a given Repository.

Parameters
Name Description
request CreateReleaseConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskReleaseConfig

The response to send back to the client (wrapped by a task).

CreateRepository(CreateRepositoryRequest, ServerCallContext)

public virtual Task<Repository> CreateRepository(CreateRepositoryRequest request, ServerCallContext context)

Creates a new Repository in a given project and location.

Parameters
Name Description
request CreateRepositoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRepository

The response to send back to the client (wrapped by a task).

CreateTeamFolder(CreateTeamFolderRequest, ServerCallContext)

public virtual Task<TeamFolder> CreateTeamFolder(CreateTeamFolderRequest request, ServerCallContext context)

Creates a new TeamFolder in a given project and location.

Parameters
Name Description
request CreateTeamFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskTeamFolder

The response to send back to the client (wrapped by a task).

CreateWorkflowConfig(CreateWorkflowConfigRequest, ServerCallContext)

public virtual Task<WorkflowConfig> CreateWorkflowConfig(CreateWorkflowConfigRequest request, ServerCallContext context)

Creates a new WorkflowConfig in a given Repository.

Parameters
Name Description
request CreateWorkflowConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkflowConfig

The response to send back to the client (wrapped by a task).

CreateWorkflowInvocation(CreateWorkflowInvocationRequest, ServerCallContext)

public virtual Task<WorkflowInvocation> CreateWorkflowInvocation(CreateWorkflowInvocationRequest request, ServerCallContext context)

Creates a new WorkflowInvocation in a given Repository.

Parameters
Name Description
request CreateWorkflowInvocationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkflowInvocation

The response to send back to the client (wrapped by a task).

CreateWorkspace(CreateWorkspaceRequest, ServerCallContext)

public virtual Task<Workspace> CreateWorkspace(CreateWorkspaceRequest request, ServerCallContext context)

Creates a new Workspace in a given Repository.

Parameters
Name Description
request CreateWorkspaceRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkspace

The response to send back to the client (wrapped by a task).

DeleteFolder(DeleteFolderRequest, ServerCallContext)

public virtual Task<Empty> DeleteFolder(DeleteFolderRequest request, ServerCallContext context)

Deletes a single Folder.

Parameters
Name Description
request DeleteFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteReleaseConfig(DeleteReleaseConfigRequest, ServerCallContext)

public virtual Task<Empty> DeleteReleaseConfig(DeleteReleaseConfigRequest request, ServerCallContext context)

Deletes a single ReleaseConfig.

Parameters
Name Description
request DeleteReleaseConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteRepository(DeleteRepositoryRequest, ServerCallContext)

public virtual Task<Empty> DeleteRepository(DeleteRepositoryRequest request, ServerCallContext context)

Deletes a single Repository.

Parameters
Name Description
request DeleteRepositoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteTeamFolder(DeleteTeamFolderRequest, ServerCallContext)

public virtual Task<Empty> DeleteTeamFolder(DeleteTeamFolderRequest request, ServerCallContext context)

Deletes a single TeamFolder.

Parameters
Name Description
request DeleteTeamFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteWorkflowConfig(DeleteWorkflowConfigRequest, ServerCallContext)

public virtual Task<Empty> DeleteWorkflowConfig(DeleteWorkflowConfigRequest request, ServerCallContext context)

Deletes a single WorkflowConfig.

Parameters
Name Description
request DeleteWorkflowConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteWorkflowInvocation(DeleteWorkflowInvocationRequest, ServerCallContext)

public virtual Task<Empty> DeleteWorkflowInvocation(DeleteWorkflowInvocationRequest request, ServerCallContext context)

Deletes a single WorkflowInvocation.

Parameters
Name Description
request DeleteWorkflowInvocationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteWorkspace(DeleteWorkspaceRequest, ServerCallContext)

public virtual Task<Empty> DeleteWorkspace(DeleteWorkspaceRequest request, ServerCallContext context)

Deletes a single Workspace.

Parameters
Name Description
request DeleteWorkspaceRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskEmpty

The response to send back to the client (wrapped by a task).

FetchFileDiff(FetchFileDiffRequest, ServerCallContext)

public virtual Task<FetchFileDiffResponse> FetchFileDiff(FetchFileDiffRequest request, ServerCallContext context)

Fetches Git diff for an uncommitted file in a Workspace.

Parameters
Name Description
request FetchFileDiffRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFetchFileDiffResponse

The response to send back to the client (wrapped by a task).

FetchFileGitStatuses(FetchFileGitStatusesRequest, ServerCallContext)

public virtual Task<FetchFileGitStatusesResponse> FetchFileGitStatuses(FetchFileGitStatusesRequest request, ServerCallContext context)

Fetches Git statuses for the files in a Workspace.

Parameters
Name Description
request FetchFileGitStatusesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFetchFileGitStatusesResponse

The response to send back to the client (wrapped by a task).

FetchGitAheadBehind(FetchGitAheadBehindRequest, ServerCallContext)

public virtual Task<FetchGitAheadBehindResponse> FetchGitAheadBehind(FetchGitAheadBehindRequest request, ServerCallContext context)

Fetches Git ahead/behind against a remote branch.

Parameters
Name Description
request FetchGitAheadBehindRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFetchGitAheadBehindResponse

The response to send back to the client (wrapped by a task).

FetchRemoteBranches(FetchRemoteBranchesRequest, ServerCallContext)

public virtual Task<FetchRemoteBranchesResponse> FetchRemoteBranches(FetchRemoteBranchesRequest request, ServerCallContext context)

Fetches a Repository's remote branches.

Parameters
Name Description
request FetchRemoteBranchesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFetchRemoteBranchesResponse

The response to send back to the client (wrapped by a task).

FetchRepositoryHistory(FetchRepositoryHistoryRequest, ServerCallContext)

public virtual Task<FetchRepositoryHistoryResponse> FetchRepositoryHistory(FetchRepositoryHistoryRequest request, ServerCallContext context)

Fetches a Repository's history of commits. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request FetchRepositoryHistoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFetchRepositoryHistoryResponse

The response to send back to the client (wrapped by a task).

GetCompilationResult(GetCompilationResultRequest, ServerCallContext)

public virtual Task<CompilationResult> GetCompilationResult(GetCompilationResultRequest request, ServerCallContext context)

Fetches a single CompilationResult.

Parameters
Name Description
request GetCompilationResultRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskCompilationResult

The response to send back to the client (wrapped by a task).

GetConfig(GetConfigRequest, ServerCallContext)

public virtual Task<Config> GetConfig(GetConfigRequest request, ServerCallContext context)

Get default config for a given project and location.

Parameters
Name Description
request GetConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskConfig

The response to send back to the client (wrapped by a task).

GetFolder(GetFolderRequest, ServerCallContext)

public virtual Task<Folder> GetFolder(GetFolderRequest request, ServerCallContext context)

Fetches a single Folder.

Parameters
Name Description
request GetFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFolder

The response to send back to the client (wrapped by a task).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters
Name Description
request GetIamPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskPolicy

The response to send back to the client (wrapped by a task).

GetReleaseConfig(GetReleaseConfigRequest, ServerCallContext)

public virtual Task<ReleaseConfig> GetReleaseConfig(GetReleaseConfigRequest request, ServerCallContext context)

Fetches a single ReleaseConfig.

Parameters
Name Description
request GetReleaseConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskReleaseConfig

The response to send back to the client (wrapped by a task).

GetRepository(GetRepositoryRequest, ServerCallContext)

public virtual Task<Repository> GetRepository(GetRepositoryRequest request, ServerCallContext context)

Fetches a single Repository.

Parameters
Name Description
request GetRepositoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRepository

The response to send back to the client (wrapped by a task).

GetTeamFolder(GetTeamFolderRequest, ServerCallContext)

public virtual Task<TeamFolder> GetTeamFolder(GetTeamFolderRequest request, ServerCallContext context)

Fetches a single TeamFolder.

Parameters
Name Description
request GetTeamFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskTeamFolder

The response to send back to the client (wrapped by a task).

GetWorkflowConfig(GetWorkflowConfigRequest, ServerCallContext)

public virtual Task<WorkflowConfig> GetWorkflowConfig(GetWorkflowConfigRequest request, ServerCallContext context)

Fetches a single WorkflowConfig.

Parameters
Name Description
request GetWorkflowConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkflowConfig

The response to send back to the client (wrapped by a task).

GetWorkflowInvocation(GetWorkflowInvocationRequest, ServerCallContext)

public virtual Task<WorkflowInvocation> GetWorkflowInvocation(GetWorkflowInvocationRequest request, ServerCallContext context)

Fetches a single WorkflowInvocation.

Parameters
Name Description
request GetWorkflowInvocationRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkflowInvocation

The response to send back to the client (wrapped by a task).

GetWorkspace(GetWorkspaceRequest, ServerCallContext)

public virtual Task<Workspace> GetWorkspace(GetWorkspaceRequest request, ServerCallContext context)

Fetches a single Workspace.

Parameters
Name Description
request GetWorkspaceRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkspace

The response to send back to the client (wrapped by a task).

InstallNpmPackages(InstallNpmPackagesRequest, ServerCallContext)

public virtual Task<InstallNpmPackagesResponse> InstallNpmPackages(InstallNpmPackagesRequest request, ServerCallContext context)

Installs dependency NPM packages (inside a Workspace).

Parameters
Name Description
request InstallNpmPackagesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskInstallNpmPackagesResponse

The response to send back to the client (wrapped by a task).

ListCompilationResults(ListCompilationResultsRequest, ServerCallContext)

public virtual Task<ListCompilationResultsResponse> ListCompilationResults(ListCompilationResultsRequest request, ServerCallContext context)

Lists CompilationResults in a given Repository.

Parameters
Name Description
request ListCompilationResultsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListCompilationResultsResponse

The response to send back to the client (wrapped by a task).

ListReleaseConfigs(ListReleaseConfigsRequest, ServerCallContext)

public virtual Task<ListReleaseConfigsResponse> ListReleaseConfigs(ListReleaseConfigsRequest request, ServerCallContext context)

Lists ReleaseConfigs in a given Repository.

Parameters
Name Description
request ListReleaseConfigsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListReleaseConfigsResponse

The response to send back to the client (wrapped by a task).

ListRepositories(ListRepositoriesRequest, ServerCallContext)

public virtual Task<ListRepositoriesResponse> ListRepositories(ListRepositoriesRequest request, ServerCallContext context)

Lists Repositories in a given project and location.

Note: This method can return repositories not shown in the Dataform UI.

Parameters
Name Description
request ListRepositoriesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListRepositoriesResponse

The response to send back to the client (wrapped by a task).

ListWorkflowConfigs(ListWorkflowConfigsRequest, ServerCallContext)

public virtual Task<ListWorkflowConfigsResponse> ListWorkflowConfigs(ListWorkflowConfigsRequest request, ServerCallContext context)

Lists WorkflowConfigs in a given Repository.

Parameters
Name Description
request ListWorkflowConfigsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListWorkflowConfigsResponse

The response to send back to the client (wrapped by a task).

ListWorkflowInvocations(ListWorkflowInvocationsRequest, ServerCallContext)

public virtual Task<ListWorkflowInvocationsResponse> ListWorkflowInvocations(ListWorkflowInvocationsRequest request, ServerCallContext context)

Lists WorkflowInvocations in a given Repository.

Parameters
Name Description
request ListWorkflowInvocationsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListWorkflowInvocationsResponse

The response to send back to the client (wrapped by a task).

ListWorkspaces(ListWorkspacesRequest, ServerCallContext)

public virtual Task<ListWorkspacesResponse> ListWorkspaces(ListWorkspacesRequest request, ServerCallContext context)

Lists Workspaces in a given Repository.

Parameters
Name Description
request ListWorkspacesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListWorkspacesResponse

The response to send back to the client (wrapped by a task).

MakeDirectory(MakeDirectoryRequest, ServerCallContext)

public virtual Task<MakeDirectoryResponse> MakeDirectory(MakeDirectoryRequest request, ServerCallContext context)

Creates a directory inside a Workspace.

Parameters
Name Description
request MakeDirectoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskMakeDirectoryResponse

The response to send back to the client (wrapped by a task).

MoveDirectory(MoveDirectoryRequest, ServerCallContext)

public virtual Task<MoveDirectoryResponse> MoveDirectory(MoveDirectoryRequest request, ServerCallContext context)

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

Parameters
Name Description
request MoveDirectoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskMoveDirectoryResponse

The response to send back to the client (wrapped by a task).

MoveFile(MoveFileRequest, ServerCallContext)

public virtual Task<MoveFileResponse> MoveFile(MoveFileRequest request, ServerCallContext context)

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

Parameters
Name Description
request MoveFileRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskMoveFileResponse

The response to send back to the client (wrapped by a task).

MoveFolder(MoveFolderRequest, ServerCallContext)

public virtual Task<Operation> MoveFolder(MoveFolderRequest request, ServerCallContext context)

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

Parameters
Name Description
request MoveFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

MoveRepository(MoveRepositoryRequest, ServerCallContext)

public virtual Task<Operation> MoveRepository(MoveRepositoryRequest request, ServerCallContext context)

Moves a Repository to a new location.

Parameters
Name Description
request MoveRepositoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

PullGitCommits(PullGitCommitsRequest, ServerCallContext)

public virtual Task<PullGitCommitsResponse> PullGitCommits(PullGitCommitsRequest request, ServerCallContext context)

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

Parameters
Name Description
request PullGitCommitsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskPullGitCommitsResponse

The response to send back to the client (wrapped by a task).

PushGitCommits(PushGitCommitsRequest, ServerCallContext)

public virtual Task<PushGitCommitsResponse> PushGitCommits(PushGitCommitsRequest request, ServerCallContext context)

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

Parameters
Name Description
request PushGitCommitsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskPushGitCommitsResponse

The response to send back to the client (wrapped by a task).

QueryCompilationResultActions(QueryCompilationResultActionsRequest, ServerCallContext)

public virtual Task<QueryCompilationResultActionsResponse> QueryCompilationResultActions(QueryCompilationResultActionsRequest request, ServerCallContext context)

Returns CompilationResultActions in a given CompilationResult.

Parameters
Name Description
request QueryCompilationResultActionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskQueryCompilationResultActionsResponse

The response to send back to the client (wrapped by a task).

QueryDirectoryContents(QueryDirectoryContentsRequest, ServerCallContext)

public virtual Task<QueryDirectoryContentsResponse> QueryDirectoryContents(QueryDirectoryContentsRequest request, ServerCallContext context)

Returns the contents of a given Workspace directory.

Parameters
Name Description
request QueryDirectoryContentsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskQueryDirectoryContentsResponse

The response to send back to the client (wrapped by a task).

QueryFolderContents(QueryFolderContentsRequest, ServerCallContext)

public virtual Task<QueryFolderContentsResponse> QueryFolderContents(QueryFolderContentsRequest request, ServerCallContext context)

Returns the contents of a given Folder.

Parameters
Name Description
request QueryFolderContentsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskQueryFolderContentsResponse

The response to send back to the client (wrapped by a task).

QueryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest, ServerCallContext)

public virtual Task<QueryRepositoryDirectoryContentsResponse> QueryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request, ServerCallContext context)

Returns the contents of a given Repository directory. The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request QueryRepositoryDirectoryContentsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskQueryRepositoryDirectoryContentsResponse

The response to send back to the client (wrapped by a task).

QueryTeamFolderContents(QueryTeamFolderContentsRequest, ServerCallContext)

public virtual Task<QueryTeamFolderContentsResponse> QueryTeamFolderContents(QueryTeamFolderContentsRequest request, ServerCallContext context)

Returns the contents of a given TeamFolder.

Parameters
Name Description
request QueryTeamFolderContentsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskQueryTeamFolderContentsResponse

The response to send back to the client (wrapped by a task).

QueryUserRootContents(QueryUserRootContentsRequest, ServerCallContext)

public virtual Task<QueryUserRootContentsResponse> QueryUserRootContents(QueryUserRootContentsRequest request, ServerCallContext context)

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

Parameters
Name Description
request QueryUserRootContentsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskQueryUserRootContentsResponse

The response to send back to the client (wrapped by a task).

QueryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest, ServerCallContext)

public virtual Task<QueryWorkflowInvocationActionsResponse> QueryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request, ServerCallContext context)

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Parameters
Name Description
request QueryWorkflowInvocationActionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskQueryWorkflowInvocationActionsResponse

The response to send back to the client (wrapped by a task).

ReadFile(ReadFileRequest, ServerCallContext)

public virtual Task<ReadFileResponse> ReadFile(ReadFileRequest request, ServerCallContext context)

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

Parameters
Name Description
request ReadFileRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskReadFileResponse

The response to send back to the client (wrapped by a task).

ReadRepositoryFile(ReadRepositoryFileRequest, ServerCallContext)

public virtual Task<ReadRepositoryFileResponse> ReadRepositoryFile(ReadRepositoryFileRequest request, ServerCallContext context)

Returns the contents of a file (inside a Repository). The Repository must not have a value for git_remote_settings.url.

Parameters
Name Description
request ReadRepositoryFileRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskReadRepositoryFileResponse

The response to send back to the client (wrapped by a task).

RemoveDirectory(RemoveDirectoryRequest, ServerCallContext)

public virtual Task<RemoveDirectoryResponse> RemoveDirectory(RemoveDirectoryRequest request, ServerCallContext context)

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

Parameters
Name Description
request RemoveDirectoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRemoveDirectoryResponse

The response to send back to the client (wrapped by a task).

RemoveFile(RemoveFileRequest, ServerCallContext)

public virtual Task<RemoveFileResponse> RemoveFile(RemoveFileRequest request, ServerCallContext context)

Deletes a file (inside a Workspace).

Parameters
Name Description
request RemoveFileRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRemoveFileResponse

The response to send back to the client (wrapped by a task).

ResetWorkspaceChanges(ResetWorkspaceChangesRequest, ServerCallContext)

public virtual Task<ResetWorkspaceChangesResponse> ResetWorkspaceChanges(ResetWorkspaceChangesRequest request, ServerCallContext context)

Performs a Git reset for uncommitted files in a Workspace.

Parameters
Name Description
request ResetWorkspaceChangesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskResetWorkspaceChangesResponse

The response to send back to the client (wrapped by a task).

SearchFiles(SearchFilesRequest, ServerCallContext)

public virtual Task<SearchFilesResponse> SearchFiles(SearchFilesRequest request, ServerCallContext context)

Finds the contents of a given Workspace directory by filter.

Parameters
Name Description
request SearchFilesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSearchFilesResponse

The response to send back to the client (wrapped by a task).

SearchTeamFolders(SearchTeamFoldersRequest, ServerCallContext)

public virtual Task<SearchTeamFoldersResponse> SearchTeamFolders(SearchTeamFoldersRequest request, ServerCallContext context)

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

Parameters
Name Description
request SearchTeamFoldersRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSearchTeamFoldersResponse

The response to send back to the client (wrapped by a task).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
Name Description
request SetIamPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskPolicy

The response to send back to the client (wrapped by a task).

TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)

public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)

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.

Parameters
Name Description
request TestIamPermissionsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskTestIamPermissionsResponse

The response to send back to the client (wrapped by a task).

UpdateConfig(UpdateConfigRequest, ServerCallContext)

public virtual Task<Config> UpdateConfig(UpdateConfigRequest request, ServerCallContext context)

Update default config for a given project and location.

Note: This method does not fully implement AIP/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.

Parameters
Name Description
request UpdateConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskConfig

The response to send back to the client (wrapped by a task).

UpdateFolder(UpdateFolderRequest, ServerCallContext)

public virtual Task<Folder> UpdateFolder(UpdateFolderRequest request, ServerCallContext context)

Updates a single Folder.

Parameters
Name Description
request UpdateFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFolder

The response to send back to the client (wrapped by a task).

UpdateReleaseConfig(UpdateReleaseConfigRequest, ServerCallContext)

public virtual Task<ReleaseConfig> UpdateReleaseConfig(UpdateReleaseConfigRequest request, ServerCallContext context)

Updates a single ReleaseConfig.

Note: This method does not fully implement AIP/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.

Parameters
Name Description
request UpdateReleaseConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskReleaseConfig

The response to send back to the client (wrapped by a task).

UpdateRepository(UpdateRepositoryRequest, ServerCallContext)

public virtual Task<Repository> UpdateRepository(UpdateRepositoryRequest request, ServerCallContext context)

Updates a single Repository.

Note: This method does not fully implement AIP/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.

Parameters
Name Description
request UpdateRepositoryRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskRepository

The response to send back to the client (wrapped by a task).

UpdateTeamFolder(UpdateTeamFolderRequest, ServerCallContext)

public virtual Task<TeamFolder> UpdateTeamFolder(UpdateTeamFolderRequest request, ServerCallContext context)

Updates a single TeamFolder.

Parameters
Name Description
request UpdateTeamFolderRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskTeamFolder

The response to send back to the client (wrapped by a task).

UpdateWorkflowConfig(UpdateWorkflowConfigRequest, ServerCallContext)

public virtual Task<WorkflowConfig> UpdateWorkflowConfig(UpdateWorkflowConfigRequest request, ServerCallContext context)

Updates a single WorkflowConfig.

Note: This method does not fully implement AIP/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.

Parameters
Name Description
request UpdateWorkflowConfigRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWorkflowConfig

The response to send back to the client (wrapped by a task).

WriteFile(WriteFileRequest, ServerCallContext)

public virtual Task<WriteFileResponse> WriteFile(WriteFileRequest request, ServerCallContext context)

Writes to a file (inside a Workspace).

Parameters
Name Description
request WriteFileRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskWriteFileResponse

The response to send back to the client (wrapped by a task).