Class DataformGrpc.DataformBlockingStub (0.36.0)

public static final class DataformGrpc.DataformBlockingStub extends AbstractBlockingStub<DataformGrpc.DataformBlockingStub>

A stub to allow clients to do synchronous 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.AbstractBlockingStub > DataformGrpc.DataformBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

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

cancelWorkflowInvocation(CancelWorkflowInvocationRequest request)

public Empty cancelWorkflowInvocation(CancelWorkflowInvocationRequest request)

Requests cancellation of a running WorkflowInvocation.

Parameter
Name Description
request CancelWorkflowInvocationRequest
Returns
Type Description
Empty

commitRepositoryChanges(CommitRepositoryChangesRequest request)

public Empty commitRepositoryChanges(CommitRepositoryChangesRequest request)

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

Parameter
Name Description
request CommitRepositoryChangesRequest
Returns
Type Description
Empty

commitWorkspaceChanges(CommitWorkspaceChangesRequest request)

public Empty commitWorkspaceChanges(CommitWorkspaceChangesRequest request)

Applies a Git commit for uncommitted files in a Workspace.

Parameter
Name Description
request CommitWorkspaceChangesRequest
Returns
Type Description
Empty

computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request)

public ComputeRepositoryAccessTokenStatusResponse computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request)

Computes a Repository's Git access token status.

Parameter
Name Description
request ComputeRepositoryAccessTokenStatusRequest
Returns
Type Description
ComputeRepositoryAccessTokenStatusResponse

createCompilationResult(CreateCompilationResultRequest request)

public CompilationResult createCompilationResult(CreateCompilationResultRequest request)

Creates a new CompilationResult in a given project and location.

Parameter
Name Description
request CreateCompilationResultRequest
Returns
Type Description
CompilationResult

createReleaseConfig(CreateReleaseConfigRequest request)

public ReleaseConfig createReleaseConfig(CreateReleaseConfigRequest request)

Creates a new ReleaseConfig in a given Repository.

Parameter
Name Description
request CreateReleaseConfigRequest
Returns
Type Description
ReleaseConfig

createRepository(CreateRepositoryRequest request)

public Repository createRepository(CreateRepositoryRequest request)

Creates a new Repository in a given project and location.

Parameter
Name Description
request CreateRepositoryRequest
Returns
Type Description
Repository

createWorkflowConfig(CreateWorkflowConfigRequest request)

public WorkflowConfig createWorkflowConfig(CreateWorkflowConfigRequest request)

Creates a new WorkflowConfig in a given Repository.

Parameter
Name Description
request CreateWorkflowConfigRequest
Returns
Type Description
WorkflowConfig

createWorkflowInvocation(CreateWorkflowInvocationRequest request)

public WorkflowInvocation createWorkflowInvocation(CreateWorkflowInvocationRequest request)

Creates a new WorkflowInvocation in a given Repository.

Parameter
Name Description
request CreateWorkflowInvocationRequest
Returns
Type Description
WorkflowInvocation

createWorkspace(CreateWorkspaceRequest request)

public Workspace createWorkspace(CreateWorkspaceRequest request)

Creates a new Workspace in a given Repository.

Parameter
Name Description
request CreateWorkspaceRequest
Returns
Type Description
Workspace

deleteReleaseConfig(DeleteReleaseConfigRequest request)

public Empty deleteReleaseConfig(DeleteReleaseConfigRequest request)

Deletes a single ReleaseConfig.

Parameter
Name Description
request DeleteReleaseConfigRequest
Returns
Type Description
Empty

deleteRepository(DeleteRepositoryRequest request)

public Empty deleteRepository(DeleteRepositoryRequest request)

Deletes a single Repository.

Parameter
Name Description
request DeleteRepositoryRequest
Returns
Type Description
Empty

deleteWorkflowConfig(DeleteWorkflowConfigRequest request)

public Empty deleteWorkflowConfig(DeleteWorkflowConfigRequest request)

Deletes a single WorkflowConfig.

Parameter
Name Description
request DeleteWorkflowConfigRequest
Returns
Type Description
Empty

deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request)

public Empty deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request)

Deletes a single WorkflowInvocation.

Parameter
Name Description
request DeleteWorkflowInvocationRequest
Returns
Type Description
Empty

deleteWorkspace(DeleteWorkspaceRequest request)

public Empty deleteWorkspace(DeleteWorkspaceRequest request)

Deletes a single Workspace.

Parameter
Name Description
request DeleteWorkspaceRequest
Returns
Type Description
Empty

fetchFileDiff(FetchFileDiffRequest request)

public FetchFileDiffResponse fetchFileDiff(FetchFileDiffRequest request)

Fetches Git diff for an uncommitted file in a Workspace.

Parameter
Name Description
request FetchFileDiffRequest
Returns
Type Description
FetchFileDiffResponse

fetchFileGitStatuses(FetchFileGitStatusesRequest request)

public FetchFileGitStatusesResponse fetchFileGitStatuses(FetchFileGitStatusesRequest request)

Fetches Git statuses for the files in a Workspace.

Parameter
Name Description
request FetchFileGitStatusesRequest
Returns
Type Description
FetchFileGitStatusesResponse

fetchGitAheadBehind(FetchGitAheadBehindRequest request)

public FetchGitAheadBehindResponse fetchGitAheadBehind(FetchGitAheadBehindRequest request)

Fetches Git ahead/behind against a remote branch.

Parameter
Name Description
request FetchGitAheadBehindRequest
Returns
Type Description
FetchGitAheadBehindResponse

fetchRemoteBranches(FetchRemoteBranchesRequest request)

public FetchRemoteBranchesResponse fetchRemoteBranches(FetchRemoteBranchesRequest request)

Fetches a Repository's remote branches.

Parameter
Name Description
request FetchRemoteBranchesRequest
Returns
Type Description
FetchRemoteBranchesResponse

fetchRepositoryHistory(FetchRepositoryHistoryRequest request)

public FetchRepositoryHistoryResponse fetchRepositoryHistory(FetchRepositoryHistoryRequest request)

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

Parameter
Name Description
request FetchRepositoryHistoryRequest
Returns
Type Description
FetchRepositoryHistoryResponse

getCompilationResult(GetCompilationResultRequest request)

public CompilationResult getCompilationResult(GetCompilationResultRequest request)

Fetches a single CompilationResult.

Parameter
Name Description
request GetCompilationResultRequest
Returns
Type Description
CompilationResult

getReleaseConfig(GetReleaseConfigRequest request)

public ReleaseConfig getReleaseConfig(GetReleaseConfigRequest request)

Fetches a single ReleaseConfig.

Parameter
Name Description
request GetReleaseConfigRequest
Returns
Type Description
ReleaseConfig

getRepository(GetRepositoryRequest request)

public Repository getRepository(GetRepositoryRequest request)

Fetches a single Repository.

Parameter
Name Description
request GetRepositoryRequest
Returns
Type Description
Repository

getWorkflowConfig(GetWorkflowConfigRequest request)

public WorkflowConfig getWorkflowConfig(GetWorkflowConfigRequest request)

Fetches a single WorkflowConfig.

Parameter
Name Description
request GetWorkflowConfigRequest
Returns
Type Description
WorkflowConfig

getWorkflowInvocation(GetWorkflowInvocationRequest request)

public WorkflowInvocation getWorkflowInvocation(GetWorkflowInvocationRequest request)

Fetches a single WorkflowInvocation.

Parameter
Name Description
request GetWorkflowInvocationRequest
Returns
Type Description
WorkflowInvocation

getWorkspace(GetWorkspaceRequest request)

public Workspace getWorkspace(GetWorkspaceRequest request)

Fetches a single Workspace.

Parameter
Name Description
request GetWorkspaceRequest
Returns
Type Description
Workspace

installNpmPackages(InstallNpmPackagesRequest request)

public InstallNpmPackagesResponse installNpmPackages(InstallNpmPackagesRequest request)

Installs dependency NPM packages (inside a Workspace).

Parameter
Name Description
request InstallNpmPackagesRequest
Returns
Type Description
InstallNpmPackagesResponse

listCompilationResults(ListCompilationResultsRequest request)

public ListCompilationResultsResponse listCompilationResults(ListCompilationResultsRequest request)

Lists CompilationResults in a given Repository.

Parameter
Name Description
request ListCompilationResultsRequest
Returns
Type Description
ListCompilationResultsResponse

listReleaseConfigs(ListReleaseConfigsRequest request)

public ListReleaseConfigsResponse listReleaseConfigs(ListReleaseConfigsRequest request)

Lists ReleaseConfigs in a given Repository.

Parameter
Name Description
request ListReleaseConfigsRequest
Returns
Type Description
ListReleaseConfigsResponse

listRepositories(ListRepositoriesRequest request)

public ListRepositoriesResponse listRepositories(ListRepositoriesRequest request)

Lists Repositories in a given project and location.

Parameter
Name Description
request ListRepositoriesRequest
Returns
Type Description
ListRepositoriesResponse

listWorkflowConfigs(ListWorkflowConfigsRequest request)

public ListWorkflowConfigsResponse listWorkflowConfigs(ListWorkflowConfigsRequest request)

Lists WorkflowConfigs in a given Repository.

Parameter
Name Description
request ListWorkflowConfigsRequest
Returns
Type Description
ListWorkflowConfigsResponse

listWorkflowInvocations(ListWorkflowInvocationsRequest request)

public ListWorkflowInvocationsResponse listWorkflowInvocations(ListWorkflowInvocationsRequest request)

Lists WorkflowInvocations in a given Repository.

Parameter
Name Description
request ListWorkflowInvocationsRequest
Returns
Type Description
ListWorkflowInvocationsResponse

listWorkspaces(ListWorkspacesRequest request)

public ListWorkspacesResponse listWorkspaces(ListWorkspacesRequest request)

Lists Workspaces in a given Repository.

Parameter
Name Description
request ListWorkspacesRequest
Returns
Type Description
ListWorkspacesResponse

makeDirectory(MakeDirectoryRequest request)

public MakeDirectoryResponse makeDirectory(MakeDirectoryRequest request)

Creates a directory inside a Workspace.

Parameter
Name Description
request MakeDirectoryRequest
Returns
Type Description
MakeDirectoryResponse

moveDirectory(MoveDirectoryRequest request)

public MoveDirectoryResponse moveDirectory(MoveDirectoryRequest request)

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

Parameter
Name Description
request MoveDirectoryRequest
Returns
Type Description
MoveDirectoryResponse

moveFile(MoveFileRequest request)

public MoveFileResponse moveFile(MoveFileRequest request)

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

Parameter
Name Description
request MoveFileRequest
Returns
Type Description
MoveFileResponse

pullGitCommits(PullGitCommitsRequest request)

public Empty pullGitCommits(PullGitCommitsRequest request)

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

Parameter
Name Description
request PullGitCommitsRequest
Returns
Type Description
Empty

pushGitCommits(PushGitCommitsRequest request)

public Empty pushGitCommits(PushGitCommitsRequest request)

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

Parameter
Name Description
request PushGitCommitsRequest
Returns
Type Description
Empty

queryCompilationResultActions(QueryCompilationResultActionsRequest request)

public QueryCompilationResultActionsResponse queryCompilationResultActions(QueryCompilationResultActionsRequest request)

Returns CompilationResultActions in a given CompilationResult.

Parameter
Name Description
request QueryCompilationResultActionsRequest
Returns
Type Description
QueryCompilationResultActionsResponse

queryDirectoryContents(QueryDirectoryContentsRequest request)

public QueryDirectoryContentsResponse queryDirectoryContents(QueryDirectoryContentsRequest request)

Returns the contents of a given Workspace directory.

Parameter
Name Description
request QueryDirectoryContentsRequest
Returns
Type Description
QueryDirectoryContentsResponse

queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request)

public QueryRepositoryDirectoryContentsResponse queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request)

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

Parameter
Name Description
request QueryRepositoryDirectoryContentsRequest
Returns
Type Description
QueryRepositoryDirectoryContentsResponse

queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request)

public QueryWorkflowInvocationActionsResponse queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request)

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Parameter
Name Description
request QueryWorkflowInvocationActionsRequest
Returns
Type Description
QueryWorkflowInvocationActionsResponse

readFile(ReadFileRequest request)

public ReadFileResponse readFile(ReadFileRequest request)

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

Parameter
Name Description
request ReadFileRequest
Returns
Type Description
ReadFileResponse

readRepositoryFile(ReadRepositoryFileRequest request)

public ReadRepositoryFileResponse readRepositoryFile(ReadRepositoryFileRequest request)

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

Parameter
Name Description
request ReadRepositoryFileRequest
Returns
Type Description
ReadRepositoryFileResponse

removeDirectory(RemoveDirectoryRequest request)

public Empty removeDirectory(RemoveDirectoryRequest request)

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

Parameter
Name Description
request RemoveDirectoryRequest
Returns
Type Description
Empty

removeFile(RemoveFileRequest request)

public Empty removeFile(RemoveFileRequest request)

Deletes a file (inside a Workspace).

Parameter
Name Description
request RemoveFileRequest
Returns
Type Description
Empty

resetWorkspaceChanges(ResetWorkspaceChangesRequest request)

public Empty resetWorkspaceChanges(ResetWorkspaceChangesRequest request)

Performs a Git reset for uncommitted files in a Workspace.

Parameter
Name Description
request ResetWorkspaceChangesRequest
Returns
Type Description
Empty

updateReleaseConfig(UpdateReleaseConfigRequest request)

public ReleaseConfig updateReleaseConfig(UpdateReleaseConfigRequest request)

Updates a single ReleaseConfig.

Parameter
Name Description
request UpdateReleaseConfigRequest
Returns
Type Description
ReleaseConfig

updateRepository(UpdateRepositoryRequest request)

public Repository updateRepository(UpdateRepositoryRequest request)

Updates a single Repository.

Parameter
Name Description
request UpdateRepositoryRequest
Returns
Type Description
Repository

updateWorkflowConfig(UpdateWorkflowConfigRequest request)

public WorkflowConfig updateWorkflowConfig(UpdateWorkflowConfigRequest request)

Updates a single WorkflowConfig.

Parameter
Name Description
request UpdateWorkflowConfigRequest
Returns
Type Description
WorkflowConfig

writeFile(WriteFileRequest request)

public WriteFileResponse writeFile(WriteFileRequest request)

Writes to a file (inside a Workspace).

Parameter
Name Description
request WriteFileRequest
Returns
Type Description
WriteFileResponse