Class DataformGrpc.DataformFutureStub (0.52.0)

public static final class DataformGrpc.DataformFutureStub extends AbstractFutureStub<DataformGrpc.DataformFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > DataformGrpc.DataformFutureStub

Methods

build(Channel channel, CallOptions callOptions)

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

cancelWorkflowInvocation(CancelWorkflowInvocationRequest request)

public ListenableFuture<Empty> cancelWorkflowInvocation(CancelWorkflowInvocationRequest request)

Requests cancellation of a running WorkflowInvocation.

Parameter
Name Description
request CancelWorkflowInvocationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

commitRepositoryChanges(CommitRepositoryChangesRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Empty>

commitWorkspaceChanges(CommitWorkspaceChangesRequest request)

public ListenableFuture<Empty> commitWorkspaceChanges(CommitWorkspaceChangesRequest request)

Applies a Git commit for uncommitted files in a Workspace.

Parameter
Name Description
request CommitWorkspaceChangesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request)

public ListenableFuture<ComputeRepositoryAccessTokenStatusResponse> computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request)

Computes a Repository's Git access token status.

Parameter
Name Description
request ComputeRepositoryAccessTokenStatusRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ComputeRepositoryAccessTokenStatusResponse>

createCompilationResult(CreateCompilationResultRequest request)

public ListenableFuture<CompilationResult> createCompilationResult(CreateCompilationResultRequest request)

Creates a new CompilationResult in a given project and location.

Parameter
Name Description
request CreateCompilationResultRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CompilationResult>

createReleaseConfig(CreateReleaseConfigRequest request)

public ListenableFuture<ReleaseConfig> createReleaseConfig(CreateReleaseConfigRequest request)

Creates a new ReleaseConfig in a given Repository.

Parameter
Name Description
request CreateReleaseConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ReleaseConfig>

createRepository(CreateRepositoryRequest request)

public ListenableFuture<Repository> createRepository(CreateRepositoryRequest request)

Creates a new Repository in a given project and location.

Parameter
Name Description
request CreateRepositoryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Repository>

createWorkflowConfig(CreateWorkflowConfigRequest request)

public ListenableFuture<WorkflowConfig> createWorkflowConfig(CreateWorkflowConfigRequest request)

Creates a new WorkflowConfig in a given Repository.

Parameter
Name Description
request CreateWorkflowConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<WorkflowConfig>

createWorkflowInvocation(CreateWorkflowInvocationRequest request)

public ListenableFuture<WorkflowInvocation> createWorkflowInvocation(CreateWorkflowInvocationRequest request)

Creates a new WorkflowInvocation in a given Repository.

Parameter
Name Description
request CreateWorkflowInvocationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<WorkflowInvocation>

createWorkspace(CreateWorkspaceRequest request)

public ListenableFuture<Workspace> createWorkspace(CreateWorkspaceRequest request)

Creates a new Workspace in a given Repository.

Parameter
Name Description
request CreateWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Workspace>

deleteReleaseConfig(DeleteReleaseConfigRequest request)

public ListenableFuture<Empty> deleteReleaseConfig(DeleteReleaseConfigRequest request)

Deletes a single ReleaseConfig.

Parameter
Name Description
request DeleteReleaseConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteRepository(DeleteRepositoryRequest request)

public ListenableFuture<Empty> deleteRepository(DeleteRepositoryRequest request)

Deletes a single Repository.

Parameter
Name Description
request DeleteRepositoryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteWorkflowConfig(DeleteWorkflowConfigRequest request)

public ListenableFuture<Empty> deleteWorkflowConfig(DeleteWorkflowConfigRequest request)

Deletes a single WorkflowConfig.

Parameter
Name Description
request DeleteWorkflowConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request)

public ListenableFuture<Empty> deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request)

Deletes a single WorkflowInvocation.

Parameter
Name Description
request DeleteWorkflowInvocationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteWorkspace(DeleteWorkspaceRequest request)

public ListenableFuture<Empty> deleteWorkspace(DeleteWorkspaceRequest request)

Deletes a single Workspace.

Parameter
Name Description
request DeleteWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

fetchFileDiff(FetchFileDiffRequest request)

public ListenableFuture<FetchFileDiffResponse> fetchFileDiff(FetchFileDiffRequest request)

Fetches Git diff for an uncommitted file in a Workspace.

Parameter
Name Description
request FetchFileDiffRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FetchFileDiffResponse>

fetchFileGitStatuses(FetchFileGitStatusesRequest request)

public ListenableFuture<FetchFileGitStatusesResponse> fetchFileGitStatuses(FetchFileGitStatusesRequest request)

Fetches Git statuses for the files in a Workspace.

Parameter
Name Description
request FetchFileGitStatusesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FetchFileGitStatusesResponse>

fetchGitAheadBehind(FetchGitAheadBehindRequest request)

public ListenableFuture<FetchGitAheadBehindResponse> fetchGitAheadBehind(FetchGitAheadBehindRequest request)

Fetches Git ahead/behind against a remote branch.

Parameter
Name Description
request FetchGitAheadBehindRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FetchGitAheadBehindResponse>

fetchRemoteBranches(FetchRemoteBranchesRequest request)

public ListenableFuture<FetchRemoteBranchesResponse> fetchRemoteBranches(FetchRemoteBranchesRequest request)

Fetches a Repository's remote branches.

Parameter
Name Description
request FetchRemoteBranchesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FetchRemoteBranchesResponse>

fetchRepositoryHistory(FetchRepositoryHistoryRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<FetchRepositoryHistoryResponse>

getCompilationResult(GetCompilationResultRequest request)

public ListenableFuture<CompilationResult> getCompilationResult(GetCompilationResultRequest request)

Fetches a single CompilationResult.

Parameter
Name Description
request GetCompilationResultRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<CompilationResult>

getReleaseConfig(GetReleaseConfigRequest request)

public ListenableFuture<ReleaseConfig> getReleaseConfig(GetReleaseConfigRequest request)

Fetches a single ReleaseConfig.

Parameter
Name Description
request GetReleaseConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ReleaseConfig>

getRepository(GetRepositoryRequest request)

public ListenableFuture<Repository> getRepository(GetRepositoryRequest request)

Fetches a single Repository.

Parameter
Name Description
request GetRepositoryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Repository>

getWorkflowConfig(GetWorkflowConfigRequest request)

public ListenableFuture<WorkflowConfig> getWorkflowConfig(GetWorkflowConfigRequest request)

Fetches a single WorkflowConfig.

Parameter
Name Description
request GetWorkflowConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<WorkflowConfig>

getWorkflowInvocation(GetWorkflowInvocationRequest request)

public ListenableFuture<WorkflowInvocation> getWorkflowInvocation(GetWorkflowInvocationRequest request)

Fetches a single WorkflowInvocation.

Parameter
Name Description
request GetWorkflowInvocationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<WorkflowInvocation>

getWorkspace(GetWorkspaceRequest request)

public ListenableFuture<Workspace> getWorkspace(GetWorkspaceRequest request)

Fetches a single Workspace.

Parameter
Name Description
request GetWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Workspace>

installNpmPackages(InstallNpmPackagesRequest request)

public ListenableFuture<InstallNpmPackagesResponse> installNpmPackages(InstallNpmPackagesRequest request)

Installs dependency NPM packages (inside a Workspace).

Parameter
Name Description
request InstallNpmPackagesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<InstallNpmPackagesResponse>

listCompilationResults(ListCompilationResultsRequest request)

public ListenableFuture<ListCompilationResultsResponse> listCompilationResults(ListCompilationResultsRequest request)

Lists CompilationResults in a given Repository.

Parameter
Name Description
request ListCompilationResultsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListCompilationResultsResponse>

listReleaseConfigs(ListReleaseConfigsRequest request)

public ListenableFuture<ListReleaseConfigsResponse> listReleaseConfigs(ListReleaseConfigsRequest request)

Lists ReleaseConfigs in a given Repository.

Parameter
Name Description
request ListReleaseConfigsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListReleaseConfigsResponse>

listRepositories(ListRepositoriesRequest request)

public ListenableFuture<ListRepositoriesResponse> listRepositories(ListRepositoriesRequest request)

Lists Repositories in a given project and location.

Parameter
Name Description
request ListRepositoriesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListRepositoriesResponse>

listWorkflowConfigs(ListWorkflowConfigsRequest request)

public ListenableFuture<ListWorkflowConfigsResponse> listWorkflowConfigs(ListWorkflowConfigsRequest request)

Lists WorkflowConfigs in a given Repository.

Parameter
Name Description
request ListWorkflowConfigsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListWorkflowConfigsResponse>

listWorkflowInvocations(ListWorkflowInvocationsRequest request)

public ListenableFuture<ListWorkflowInvocationsResponse> listWorkflowInvocations(ListWorkflowInvocationsRequest request)

Lists WorkflowInvocations in a given Repository.

Parameter
Name Description
request ListWorkflowInvocationsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListWorkflowInvocationsResponse>

listWorkspaces(ListWorkspacesRequest request)

public ListenableFuture<ListWorkspacesResponse> listWorkspaces(ListWorkspacesRequest request)

Lists Workspaces in a given Repository.

Parameter
Name Description
request ListWorkspacesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListWorkspacesResponse>

makeDirectory(MakeDirectoryRequest request)

public ListenableFuture<MakeDirectoryResponse> makeDirectory(MakeDirectoryRequest request)

Creates a directory inside a Workspace.

Parameter
Name Description
request MakeDirectoryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MakeDirectoryResponse>

moveDirectory(MoveDirectoryRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<MoveDirectoryResponse>

moveFile(MoveFileRequest request)

public ListenableFuture<MoveFileResponse> moveFile(MoveFileRequest request)

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

Parameter
Name Description
request MoveFileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MoveFileResponse>

pullGitCommits(PullGitCommitsRequest request)

public ListenableFuture<Empty> pullGitCommits(PullGitCommitsRequest request)

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

Parameter
Name Description
request PullGitCommitsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

pushGitCommits(PushGitCommitsRequest request)

public ListenableFuture<Empty> pushGitCommits(PushGitCommitsRequest request)

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

Parameter
Name Description
request PushGitCommitsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

queryCompilationResultActions(QueryCompilationResultActionsRequest request)

public ListenableFuture<QueryCompilationResultActionsResponse> queryCompilationResultActions(QueryCompilationResultActionsRequest request)

Returns CompilationResultActions in a given CompilationResult.

Parameter
Name Description
request QueryCompilationResultActionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<QueryCompilationResultActionsResponse>

queryDirectoryContents(QueryDirectoryContentsRequest request)

public ListenableFuture<QueryDirectoryContentsResponse> queryDirectoryContents(QueryDirectoryContentsRequest request)

Returns the contents of a given Workspace directory.

Parameter
Name Description
request QueryDirectoryContentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<QueryDirectoryContentsResponse>

queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<QueryRepositoryDirectoryContentsResponse>

queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request)

public ListenableFuture<QueryWorkflowInvocationActionsResponse> queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request)

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Parameter
Name Description
request QueryWorkflowInvocationActionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<QueryWorkflowInvocationActionsResponse>

readFile(ReadFileRequest request)

public ListenableFuture<ReadFileResponse> readFile(ReadFileRequest request)

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

Parameter
Name Description
request ReadFileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ReadFileResponse>

readRepositoryFile(ReadRepositoryFileRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<ReadRepositoryFileResponse>

removeDirectory(RemoveDirectoryRequest request)

public ListenableFuture<Empty> removeDirectory(RemoveDirectoryRequest request)

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

Parameter
Name Description
request RemoveDirectoryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

removeFile(RemoveFileRequest request)

public ListenableFuture<Empty> removeFile(RemoveFileRequest request)

Deletes a file (inside a Workspace).

Parameter
Name Description
request RemoveFileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

resetWorkspaceChanges(ResetWorkspaceChangesRequest request)

public ListenableFuture<Empty> resetWorkspaceChanges(ResetWorkspaceChangesRequest request)

Performs a Git reset for uncommitted files in a Workspace.

Parameter
Name Description
request ResetWorkspaceChangesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

updateReleaseConfig(UpdateReleaseConfigRequest request)

public ListenableFuture<ReleaseConfig> updateReleaseConfig(UpdateReleaseConfigRequest request)

Updates a single ReleaseConfig.

Parameter
Name Description
request UpdateReleaseConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ReleaseConfig>

updateRepository(UpdateRepositoryRequest request)

public ListenableFuture<Repository> updateRepository(UpdateRepositoryRequest request)

Updates a single Repository.

Parameter
Name Description
request UpdateRepositoryRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Repository>

updateWorkflowConfig(UpdateWorkflowConfigRequest request)

public ListenableFuture<WorkflowConfig> updateWorkflowConfig(UpdateWorkflowConfigRequest request)

Updates a single WorkflowConfig.

Parameter
Name Description
request UpdateWorkflowConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<WorkflowConfig>

writeFile(WriteFileRequest request)

public ListenableFuture<WriteFileResponse> writeFile(WriteFileRequest request)

Writes to a file (inside a Workspace).

Parameter
Name Description
request WriteFileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<WriteFileResponse>