Class DataformGrpc.DataformStub (0.67.0) 

public static final class DataformGrpc.DataformStub extends AbstractAsyncStub<DataformGrpc.DataformStub>

A stub to allow clients to do asynchronous rpc calls to service Dataform.

Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > DataformGrpc.DataformStub

Methods

build(Channel channel, CallOptions callOptions)

protected DataformGrpc.DataformStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DataformGrpc.DataformStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

cancelWorkflowInvocation(CancelWorkflowInvocationRequest request, StreamObserver<CancelWorkflowInvocationResponse> responseObserver)

public void cancelWorkflowInvocation(CancelWorkflowInvocationRequest request, StreamObserver<CancelWorkflowInvocationResponse> responseObserver)

Requests cancellation of a running WorkflowInvocation.

Parameters
Name Description
request CancelWorkflowInvocationRequest
responseObserver io.grpc.stub.StreamObserver<CancelWorkflowInvocationResponse>

commitRepositoryChanges(CommitRepositoryChangesRequest request, StreamObserver<CommitRepositoryChangesResponse> responseObserver)

public void commitRepositoryChanges(CommitRepositoryChangesRequest request, StreamObserver<CommitRepositoryChangesResponse> responseObserver)

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

Parameters
Name Description
request CommitRepositoryChangesRequest
responseObserver io.grpc.stub.StreamObserver<CommitRepositoryChangesResponse>

commitWorkspaceChanges(CommitWorkspaceChangesRequest request, StreamObserver<CommitWorkspaceChangesResponse> responseObserver)

public void commitWorkspaceChanges(CommitWorkspaceChangesRequest request, StreamObserver<CommitWorkspaceChangesResponse> responseObserver)

Applies a Git commit for uncommitted files in a Workspace.

Parameters
Name Description
request CommitWorkspaceChangesRequest
responseObserver io.grpc.stub.StreamObserver<CommitWorkspaceChangesResponse>

computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request, StreamObserver<ComputeRepositoryAccessTokenStatusResponse> responseObserver)

public void computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request, StreamObserver<ComputeRepositoryAccessTokenStatusResponse> responseObserver)

Computes a Repository's Git access token status.

Parameters
Name Description
request ComputeRepositoryAccessTokenStatusRequest
responseObserver io.grpc.stub.StreamObserver<ComputeRepositoryAccessTokenStatusResponse>

createCompilationResult(CreateCompilationResultRequest request, StreamObserver<CompilationResult> responseObserver)

public void createCompilationResult(CreateCompilationResultRequest request, StreamObserver<CompilationResult> responseObserver)

Creates a new CompilationResult in a given project and location.

Parameters
Name Description
request CreateCompilationResultRequest
responseObserver io.grpc.stub.StreamObserver<CompilationResult>

createReleaseConfig(CreateReleaseConfigRequest request, StreamObserver<ReleaseConfig> responseObserver)

public void createReleaseConfig(CreateReleaseConfigRequest request, StreamObserver<ReleaseConfig> responseObserver)

Creates a new ReleaseConfig in a given Repository.

Parameters
Name Description
request CreateReleaseConfigRequest
responseObserver io.grpc.stub.StreamObserver<ReleaseConfig>

createRepository(CreateRepositoryRequest request, StreamObserver<Repository> responseObserver)

public void createRepository(CreateRepositoryRequest request, StreamObserver<Repository> responseObserver)

Creates a new Repository in a given project and location.

Parameters
Name Description
request CreateRepositoryRequest
responseObserver io.grpc.stub.StreamObserver<Repository>

createWorkflowConfig(CreateWorkflowConfigRequest request, StreamObserver<WorkflowConfig> responseObserver)

public void createWorkflowConfig(CreateWorkflowConfigRequest request, StreamObserver<WorkflowConfig> responseObserver)

Creates a new WorkflowConfig in a given Repository.

Parameters
Name Description
request CreateWorkflowConfigRequest
responseObserver io.grpc.stub.StreamObserver<WorkflowConfig>

createWorkflowInvocation(CreateWorkflowInvocationRequest request, StreamObserver<WorkflowInvocation> responseObserver)

public void createWorkflowInvocation(CreateWorkflowInvocationRequest request, StreamObserver<WorkflowInvocation> responseObserver)

Creates a new WorkflowInvocation in a given Repository.

Parameters
Name Description
request CreateWorkflowInvocationRequest
responseObserver io.grpc.stub.StreamObserver<WorkflowInvocation>

createWorkspace(CreateWorkspaceRequest request, StreamObserver<Workspace> responseObserver)

public void createWorkspace(CreateWorkspaceRequest request, StreamObserver<Workspace> responseObserver)

Creates a new Workspace in a given Repository.

Parameters
Name Description
request CreateWorkspaceRequest
responseObserver io.grpc.stub.StreamObserver<Workspace>

deleteReleaseConfig(DeleteReleaseConfigRequest request, StreamObserver<Empty> responseObserver)

public void deleteReleaseConfig(DeleteReleaseConfigRequest request, StreamObserver<Empty> responseObserver)

Deletes a single ReleaseConfig.

Parameters
Name Description
request DeleteReleaseConfigRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteRepository(DeleteRepositoryRequest request, StreamObserver<Empty> responseObserver)

public void deleteRepository(DeleteRepositoryRequest request, StreamObserver<Empty> responseObserver)

Deletes a single Repository.

Parameters
Name Description
request DeleteRepositoryRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteWorkflowConfig(DeleteWorkflowConfigRequest request, StreamObserver<Empty> responseObserver)

public void deleteWorkflowConfig(DeleteWorkflowConfigRequest request, StreamObserver<Empty> responseObserver)

Deletes a single WorkflowConfig.

Parameters
Name Description
request DeleteWorkflowConfigRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request, StreamObserver<Empty> responseObserver)

public void deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request, StreamObserver<Empty> responseObserver)

Deletes a single WorkflowInvocation.

Parameters
Name Description
request DeleteWorkflowInvocationRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteWorkspace(DeleteWorkspaceRequest request, StreamObserver<Empty> responseObserver)

public void deleteWorkspace(DeleteWorkspaceRequest request, StreamObserver<Empty> responseObserver)

Deletes a single Workspace.

Parameters
Name Description
request DeleteWorkspaceRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

fetchFileDiff(FetchFileDiffRequest request, StreamObserver<FetchFileDiffResponse> responseObserver)

public void fetchFileDiff(FetchFileDiffRequest request, StreamObserver<FetchFileDiffResponse> responseObserver)

Fetches Git diff for an uncommitted file in a Workspace.

Parameters
Name Description
request FetchFileDiffRequest
responseObserver io.grpc.stub.StreamObserver<FetchFileDiffResponse>

fetchFileGitStatuses(FetchFileGitStatusesRequest request, StreamObserver<FetchFileGitStatusesResponse> responseObserver)

public void fetchFileGitStatuses(FetchFileGitStatusesRequest request, StreamObserver<FetchFileGitStatusesResponse> responseObserver)

Fetches Git statuses for the files in a Workspace.

Parameters
Name Description
request FetchFileGitStatusesRequest
responseObserver io.grpc.stub.StreamObserver<FetchFileGitStatusesResponse>

fetchGitAheadBehind(FetchGitAheadBehindRequest request, StreamObserver<FetchGitAheadBehindResponse> responseObserver)

public void fetchGitAheadBehind(FetchGitAheadBehindRequest request, StreamObserver<FetchGitAheadBehindResponse> responseObserver)

Fetches Git ahead/behind against a remote branch.

Parameters
Name Description
request FetchGitAheadBehindRequest
responseObserver io.grpc.stub.StreamObserver<FetchGitAheadBehindResponse>

fetchRemoteBranches(FetchRemoteBranchesRequest request, StreamObserver<FetchRemoteBranchesResponse> responseObserver)

public void fetchRemoteBranches(FetchRemoteBranchesRequest request, StreamObserver<FetchRemoteBranchesResponse> responseObserver)

Fetches a Repository's remote branches.

Parameters
Name Description
request FetchRemoteBranchesRequest
responseObserver io.grpc.stub.StreamObserver<FetchRemoteBranchesResponse>

fetchRepositoryHistory(FetchRepositoryHistoryRequest request, StreamObserver<FetchRepositoryHistoryResponse> responseObserver)

public void fetchRepositoryHistory(FetchRepositoryHistoryRequest request, StreamObserver<FetchRepositoryHistoryResponse> responseObserver)

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

Parameters
Name Description
request FetchRepositoryHistoryRequest
responseObserver io.grpc.stub.StreamObserver<FetchRepositoryHistoryResponse>

getCompilationResult(GetCompilationResultRequest request, StreamObserver<CompilationResult> responseObserver)

public void getCompilationResult(GetCompilationResultRequest request, StreamObserver<CompilationResult> responseObserver)

Fetches a single CompilationResult.

Parameters
Name Description
request GetCompilationResultRequest
responseObserver io.grpc.stub.StreamObserver<CompilationResult>

getConfig(GetConfigRequest request, StreamObserver<Config> responseObserver)

public void getConfig(GetConfigRequest request, StreamObserver<Config> responseObserver)

Get default config for a given project and location.

Parameters
Name Description
request GetConfigRequest
responseObserver io.grpc.stub.StreamObserver<Config>

getReleaseConfig(GetReleaseConfigRequest request, StreamObserver<ReleaseConfig> responseObserver)

public void getReleaseConfig(GetReleaseConfigRequest request, StreamObserver<ReleaseConfig> responseObserver)

Fetches a single ReleaseConfig.

Parameters
Name Description
request GetReleaseConfigRequest
responseObserver io.grpc.stub.StreamObserver<ReleaseConfig>

getRepository(GetRepositoryRequest request, StreamObserver<Repository> responseObserver)

public void getRepository(GetRepositoryRequest request, StreamObserver<Repository> responseObserver)

Fetches a single Repository.

Parameters
Name Description
request GetRepositoryRequest
responseObserver io.grpc.stub.StreamObserver<Repository>

getWorkflowConfig(GetWorkflowConfigRequest request, StreamObserver<WorkflowConfig> responseObserver)

public void getWorkflowConfig(GetWorkflowConfigRequest request, StreamObserver<WorkflowConfig> responseObserver)

Fetches a single WorkflowConfig.

Parameters
Name Description
request GetWorkflowConfigRequest
responseObserver io.grpc.stub.StreamObserver<WorkflowConfig>

getWorkflowInvocation(GetWorkflowInvocationRequest request, StreamObserver<WorkflowInvocation> responseObserver)

public void getWorkflowInvocation(GetWorkflowInvocationRequest request, StreamObserver<WorkflowInvocation> responseObserver)

Fetches a single WorkflowInvocation.

Parameters
Name Description
request GetWorkflowInvocationRequest
responseObserver io.grpc.stub.StreamObserver<WorkflowInvocation>

getWorkspace(GetWorkspaceRequest request, StreamObserver<Workspace> responseObserver)

public void getWorkspace(GetWorkspaceRequest request, StreamObserver<Workspace> responseObserver)

Fetches a single Workspace.

Parameters
Name Description
request GetWorkspaceRequest
responseObserver io.grpc.stub.StreamObserver<Workspace>

installNpmPackages(InstallNpmPackagesRequest request, StreamObserver<InstallNpmPackagesResponse> responseObserver)

public void installNpmPackages(InstallNpmPackagesRequest request, StreamObserver<InstallNpmPackagesResponse> responseObserver)

Installs dependency NPM packages (inside a Workspace).

Parameters
Name Description
request InstallNpmPackagesRequest
responseObserver io.grpc.stub.StreamObserver<InstallNpmPackagesResponse>

listCompilationResults(ListCompilationResultsRequest request, StreamObserver<ListCompilationResultsResponse> responseObserver)

public void listCompilationResults(ListCompilationResultsRequest request, StreamObserver<ListCompilationResultsResponse> responseObserver)

Lists CompilationResults in a given Repository.

Parameters
Name Description
request ListCompilationResultsRequest
responseObserver io.grpc.stub.StreamObserver<ListCompilationResultsResponse>

listReleaseConfigs(ListReleaseConfigsRequest request, StreamObserver<ListReleaseConfigsResponse> responseObserver)

public void listReleaseConfigs(ListReleaseConfigsRequest request, StreamObserver<ListReleaseConfigsResponse> responseObserver)

Lists ReleaseConfigs in a given Repository.

Parameters
Name Description
request ListReleaseConfigsRequest
responseObserver io.grpc.stub.StreamObserver<ListReleaseConfigsResponse>

listRepositories(ListRepositoriesRequest request, StreamObserver<ListRepositoriesResponse> responseObserver)

public void listRepositories(ListRepositoriesRequest request, StreamObserver<ListRepositoriesResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<ListRepositoriesResponse>

listWorkflowConfigs(ListWorkflowConfigsRequest request, StreamObserver<ListWorkflowConfigsResponse> responseObserver)

public void listWorkflowConfigs(ListWorkflowConfigsRequest request, StreamObserver<ListWorkflowConfigsResponse> responseObserver)

Lists WorkflowConfigs in a given Repository.

Parameters
Name Description
request ListWorkflowConfigsRequest
responseObserver io.grpc.stub.StreamObserver<ListWorkflowConfigsResponse>

listWorkflowInvocations(ListWorkflowInvocationsRequest request, StreamObserver<ListWorkflowInvocationsResponse> responseObserver)

public void listWorkflowInvocations(ListWorkflowInvocationsRequest request, StreamObserver<ListWorkflowInvocationsResponse> responseObserver)

Lists WorkflowInvocations in a given Repository.

Parameters
Name Description
request ListWorkflowInvocationsRequest
responseObserver io.grpc.stub.StreamObserver<ListWorkflowInvocationsResponse>

listWorkspaces(ListWorkspacesRequest request, StreamObserver<ListWorkspacesResponse> responseObserver)

public void listWorkspaces(ListWorkspacesRequest request, StreamObserver<ListWorkspacesResponse> responseObserver)

Lists Workspaces in a given Repository.

Parameters
Name Description
request ListWorkspacesRequest
responseObserver io.grpc.stub.StreamObserver<ListWorkspacesResponse>

makeDirectory(MakeDirectoryRequest request, StreamObserver<MakeDirectoryResponse> responseObserver)

public void makeDirectory(MakeDirectoryRequest request, StreamObserver<MakeDirectoryResponse> responseObserver)

Creates a directory inside a Workspace.

Parameters
Name Description
request MakeDirectoryRequest
responseObserver io.grpc.stub.StreamObserver<MakeDirectoryResponse>

moveDirectory(MoveDirectoryRequest request, StreamObserver<MoveDirectoryResponse> responseObserver)

public void moveDirectory(MoveDirectoryRequest request, StreamObserver<MoveDirectoryResponse> responseObserver)

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

Parameters
Name Description
request MoveDirectoryRequest
responseObserver io.grpc.stub.StreamObserver<MoveDirectoryResponse>

moveFile(MoveFileRequest request, StreamObserver<MoveFileResponse> responseObserver)

public void moveFile(MoveFileRequest request, StreamObserver<MoveFileResponse> responseObserver)

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

Parameters
Name Description
request MoveFileRequest
responseObserver io.grpc.stub.StreamObserver<MoveFileResponse>

pullGitCommits(PullGitCommitsRequest request, StreamObserver<PullGitCommitsResponse> responseObserver)

public void pullGitCommits(PullGitCommitsRequest request, StreamObserver<PullGitCommitsResponse> responseObserver)

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

Parameters
Name Description
request PullGitCommitsRequest
responseObserver io.grpc.stub.StreamObserver<PullGitCommitsResponse>

pushGitCommits(PushGitCommitsRequest request, StreamObserver<PushGitCommitsResponse> responseObserver)

public void pushGitCommits(PushGitCommitsRequest request, StreamObserver<PushGitCommitsResponse> responseObserver)

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

Parameters
Name Description
request PushGitCommitsRequest
responseObserver io.grpc.stub.StreamObserver<PushGitCommitsResponse>

queryCompilationResultActions(QueryCompilationResultActionsRequest request, StreamObserver<QueryCompilationResultActionsResponse> responseObserver)

public void queryCompilationResultActions(QueryCompilationResultActionsRequest request, StreamObserver<QueryCompilationResultActionsResponse> responseObserver)

Returns CompilationResultActions in a given CompilationResult.

Parameters
Name Description
request QueryCompilationResultActionsRequest
responseObserver io.grpc.stub.StreamObserver<QueryCompilationResultActionsResponse>

queryDirectoryContents(QueryDirectoryContentsRequest request, StreamObserver<QueryDirectoryContentsResponse> responseObserver)

public void queryDirectoryContents(QueryDirectoryContentsRequest request, StreamObserver<QueryDirectoryContentsResponse> responseObserver)

Returns the contents of a given Workspace directory.

Parameters
Name Description
request QueryDirectoryContentsRequest
responseObserver io.grpc.stub.StreamObserver<QueryDirectoryContentsResponse>

queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request, StreamObserver<QueryRepositoryDirectoryContentsResponse> responseObserver)

public void queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request, StreamObserver<QueryRepositoryDirectoryContentsResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<QueryRepositoryDirectoryContentsResponse>

queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request, StreamObserver<QueryWorkflowInvocationActionsResponse> responseObserver)

public void queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request, StreamObserver<QueryWorkflowInvocationActionsResponse> responseObserver)

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Parameters
Name Description
request QueryWorkflowInvocationActionsRequest
responseObserver io.grpc.stub.StreamObserver<QueryWorkflowInvocationActionsResponse>

readFile(ReadFileRequest request, StreamObserver<ReadFileResponse> responseObserver)

public void readFile(ReadFileRequest request, StreamObserver<ReadFileResponse> responseObserver)

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

Parameters
Name Description
request ReadFileRequest
responseObserver io.grpc.stub.StreamObserver<ReadFileResponse>

readRepositoryFile(ReadRepositoryFileRequest request, StreamObserver<ReadRepositoryFileResponse> responseObserver)

public void readRepositoryFile(ReadRepositoryFileRequest request, StreamObserver<ReadRepositoryFileResponse> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<ReadRepositoryFileResponse>

removeDirectory(RemoveDirectoryRequest request, StreamObserver<RemoveDirectoryResponse> responseObserver)

public void removeDirectory(RemoveDirectoryRequest request, StreamObserver<RemoveDirectoryResponse> responseObserver)

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

Parameters
Name Description
request RemoveDirectoryRequest
responseObserver io.grpc.stub.StreamObserver<RemoveDirectoryResponse>

removeFile(RemoveFileRequest request, StreamObserver<RemoveFileResponse> responseObserver)

public void removeFile(RemoveFileRequest request, StreamObserver<RemoveFileResponse> responseObserver)

Deletes a file (inside a Workspace).

Parameters
Name Description
request RemoveFileRequest
responseObserver io.grpc.stub.StreamObserver<RemoveFileResponse>

resetWorkspaceChanges(ResetWorkspaceChangesRequest request, StreamObserver<ResetWorkspaceChangesResponse> responseObserver)

public void resetWorkspaceChanges(ResetWorkspaceChangesRequest request, StreamObserver<ResetWorkspaceChangesResponse> responseObserver)

Performs a Git reset for uncommitted files in a Workspace.

Parameters
Name Description
request ResetWorkspaceChangesRequest
responseObserver io.grpc.stub.StreamObserver<ResetWorkspaceChangesResponse>

searchFiles(SearchFilesRequest request, StreamObserver<SearchFilesResponse> responseObserver)

public void searchFiles(SearchFilesRequest request, StreamObserver<SearchFilesResponse> responseObserver)

Finds the contents of a given Workspace directory by filter.

Parameters
Name Description
request SearchFilesRequest
responseObserver io.grpc.stub.StreamObserver<SearchFilesResponse>

updateConfig(UpdateConfigRequest request, StreamObserver<Config> responseObserver)

public void updateConfig(UpdateConfigRequest request, StreamObserver<Config> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Config>

updateReleaseConfig(UpdateReleaseConfigRequest request, StreamObserver<ReleaseConfig> responseObserver)

public void updateReleaseConfig(UpdateReleaseConfigRequest request, StreamObserver<ReleaseConfig> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<ReleaseConfig>

updateRepository(UpdateRepositoryRequest request, StreamObserver<Repository> responseObserver)

public void updateRepository(UpdateRepositoryRequest request, StreamObserver<Repository> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<Repository>

updateWorkflowConfig(UpdateWorkflowConfigRequest request, StreamObserver<WorkflowConfig> responseObserver)

public void updateWorkflowConfig(UpdateWorkflowConfigRequest request, StreamObserver<WorkflowConfig> responseObserver)

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
responseObserver io.grpc.stub.StreamObserver<WorkflowConfig>

writeFile(WriteFileRequest request, StreamObserver<WriteFileResponse> responseObserver)

public void writeFile(WriteFileRequest request, StreamObserver<WriteFileResponse> responseObserver)

Writes to a file (inside a Workspace).

Parameters
Name Description
request WriteFileRequest
responseObserver io.grpc.stub.StreamObserver<WriteFileResponse>