Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class DataformClient (0.94.0)

GitHub Repository

Product Reference

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   TeamFolderName name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]");
   TeamFolder response = dataformClient.getTeamFolder(name);
 }

Note: close() needs to be called on the DataformClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
GetTeamFolder	Fetches a single TeamFolder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getTeamFolder(GetTeamFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTeamFolder(TeamFolderName name) getTeamFolder(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getTeamFolderCallable()
CreateTeamFolder	Creates a new TeamFolder in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createTeamFolder(CreateTeamFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createTeamFolder(LocationName parent, TeamFolder teamFolder) createTeamFolder(String parent, TeamFolder teamFolder) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTeamFolderCallable()
UpdateTeamFolder	Updates a single TeamFolder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateTeamFolder(UpdateTeamFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateTeamFolder(TeamFolder teamFolder, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateTeamFolderCallable()
DeleteTeamFolder	Deletes a single TeamFolder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTeamFolder(DeleteTeamFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteTeamFolder(TeamFolderName name) deleteTeamFolder(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteTeamFolderCallable()
DeleteTeamFolderTree	Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTeamFolderTreeAsync(DeleteTeamFolderTreeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteTeamFolderTreeAsync(TeamFolderName name, boolean force) deleteTeamFolderTreeAsync(String name, boolean force) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteTeamFolderTreeOperationCallable() deleteTeamFolderTreeCallable()
QueryTeamFolderContents	Returns the contents of a given TeamFolder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryTeamFolderContents(QueryTeamFolderContentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. queryTeamFolderContents(TeamFolderName teamFolder) queryTeamFolderContents(String teamFolder) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryTeamFolderContentsPagedCallable() queryTeamFolderContentsCallable()
SearchTeamFolders	Returns all TeamFolders in a given location that the caller has access to and match the provided filter.	Request object method variants only take one parameter, a request object, which must be constructed before the call. searchTeamFolders(SearchTeamFoldersRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. searchTeamFoldersPagedCallable() searchTeamFoldersCallable()
GetFolder	Fetches a single Folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getFolder(GetFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getFolder(FolderName name) getFolder(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getFolderCallable()
CreateFolder	Creates a new Folder in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createFolder(CreateFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createFolder(LocationName parent, Folder folder) createFolder(String parent, Folder folder) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createFolderCallable()
UpdateFolder	Updates a single Folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateFolder(UpdateFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateFolder(Folder folder, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateFolderCallable()
DeleteFolder	Deletes a single Folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteFolder(DeleteFolderRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteFolder(FolderName name) deleteFolder(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteFolderCallable()
DeleteFolderTree	Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteFolderTreeAsync(DeleteFolderTreeRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteFolderTreeAsync(FolderName name, boolean force) deleteFolderTreeAsync(String name, boolean force) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteFolderTreeOperationCallable() deleteFolderTreeCallable()
QueryFolderContents	Returns the contents of a given Folder.	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryFolderContents(QueryFolderContentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. queryFolderContents(FolderName folder) queryFolderContents(String folder) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryFolderContentsPagedCallable() queryFolderContentsCallable()
QueryUserRootContents	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryUserRootContents(QueryUserRootContentsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. queryUserRootContents(LocationName location) queryUserRootContents(String location) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryUserRootContentsPagedCallable() queryUserRootContentsCallable()
MoveFolder	Moves a Folder to a new Folder, TeamFolder, or the root location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. moveFolderAsync(MoveFolderRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. moveFolderAsync(FolderName name, String destinationContainingFolder) moveFolderAsync(String name, String destinationContainingFolder) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. moveFolderOperationCallable() moveFolderCallable()
ListRepositories	Lists Repositories in a given project and location. Note: This method can return repositories not shown in the Dataform UI.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listRepositories(ListRepositoriesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listRepositories(LocationName parent) listRepositories(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listRepositoriesPagedCallable() listRepositoriesCallable()
GetRepository	Fetches a single Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getRepository(GetRepositoryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getRepository(RepositoryName name) getRepository(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getRepositoryCallable()
CreateRepository	Creates a new Repository in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createRepository(CreateRepositoryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createRepository(LocationName parent, Repository repository, String repositoryId) createRepository(String parent, Repository repository, String repositoryId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createRepositoryCallable()
UpdateRepository	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.*	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateRepository(UpdateRepositoryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateRepository(Repository repository, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateRepositoryCallable()
DeleteRepository	Deletes a single Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteRepository(DeleteRepositoryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteRepository(RepositoryName name) deleteRepository(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteRepositoryCallable()
MoveRepository	Moves a Repository to a new location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. moveRepositoryAsync(MoveRepositoryRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. moveRepositoryAsync(RepositoryName name, String destinationContainingFolder) moveRepositoryAsync(String name, String destinationContainingFolder) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. moveRepositoryOperationCallable() moveRepositoryCallable()
CommitRepositoryChanges	Applies a Git commit to a Repository. The Repository must not have a value for `git_remote_settings.url`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. commitRepositoryChanges(CommitRepositoryChangesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. commitRepositoryChangesCallable()
ReadRepositoryFile	Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. readRepositoryFile(ReadRepositoryFileRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. readRepositoryFileCallable()
QueryRepositoryDirectoryContents	Returns the contents of a given Repository directory. The Repository must not have a value for `git_remote_settings.url`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryRepositoryDirectoryContentsPagedCallable() queryRepositoryDirectoryContentsCallable()
FetchRepositoryHistory	Fetches a Repository's history of commits. The Repository must not have a value for `git_remote_settings.url`.	Request object method variants only take one parameter, a request object, which must be constructed before the call. fetchRepositoryHistory(FetchRepositoryHistoryRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. fetchRepositoryHistoryPagedCallable() fetchRepositoryHistoryCallable()
ComputeRepositoryAccessTokenStatus	Computes a Repository's Git access token status.	Request object method variants only take one parameter, a request object, which must be constructed before the call. computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. computeRepositoryAccessTokenStatusCallable()
FetchRemoteBranches	Fetches a Repository's remote branches.	Request object method variants only take one parameter, a request object, which must be constructed before the call. fetchRemoteBranches(FetchRemoteBranchesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. fetchRemoteBranchesCallable()
ListWorkspaces	Lists Workspaces in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listWorkspaces(ListWorkspacesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listWorkspaces(RepositoryName parent) listWorkspaces(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listWorkspacesPagedCallable() listWorkspacesCallable()
GetWorkspace	Fetches a single Workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getWorkspace(GetWorkspaceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getWorkspace(WorkspaceName name) getWorkspace(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getWorkspaceCallable()
CreateWorkspace	Creates a new Workspace in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createWorkspace(CreateWorkspaceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createWorkspace(RepositoryName parent, Workspace workspace, String workspaceId) createWorkspace(String parent, Workspace workspace, String workspaceId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createWorkspaceCallable()
DeleteWorkspace	Deletes a single Workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteWorkspace(DeleteWorkspaceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteWorkspace(WorkspaceName name) deleteWorkspace(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteWorkspaceCallable()
InstallNpmPackages	Installs dependency NPM packages (inside a Workspace).	Request object method variants only take one parameter, a request object, which must be constructed before the call. installNpmPackages(InstallNpmPackagesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. installNpmPackagesCallable()
PullGitCommits	Pulls Git commits from the Repository's remote into a Workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. pullGitCommits(PullGitCommitsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. pullGitCommitsCallable()
PushGitCommits	Pushes Git commits from a Workspace to the Repository's remote.	Request object method variants only take one parameter, a request object, which must be constructed before the call. pushGitCommits(PushGitCommitsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. pushGitCommitsCallable()
FetchFileGitStatuses	Fetches Git statuses for the files in a Workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. fetchFileGitStatuses(FetchFileGitStatusesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. fetchFileGitStatusesCallable()
FetchGitAheadBehind	Fetches Git ahead/behind against a remote branch.	Request object method variants only take one parameter, a request object, which must be constructed before the call. fetchGitAheadBehind(FetchGitAheadBehindRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. fetchGitAheadBehindCallable()
CommitWorkspaceChanges	Applies a Git commit for uncommitted files in a Workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. commitWorkspaceChanges(CommitWorkspaceChangesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. commitWorkspaceChangesCallable()
ResetWorkspaceChanges	Performs a Git reset for uncommitted files in a Workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. resetWorkspaceChanges(ResetWorkspaceChangesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. resetWorkspaceChangesCallable()
FetchFileDiff	Fetches Git diff for an uncommitted file in a Workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. fetchFileDiff(FetchFileDiffRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. fetchFileDiffCallable()
QueryDirectoryContents	Returns the contents of a given Workspace directory.	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryDirectoryContents(QueryDirectoryContentsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryDirectoryContentsPagedCallable() queryDirectoryContentsCallable()
SearchFiles	Finds the contents of a given Workspace directory by filter.	Request object method variants only take one parameter, a request object, which must be constructed before the call. searchFiles(SearchFilesRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. searchFilesPagedCallable() searchFilesCallable()
MakeDirectory	Creates a directory inside a Workspace.	Request object method variants only take one parameter, a request object, which must be constructed before the call. makeDirectory(MakeDirectoryRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. makeDirectoryCallable()
RemoveDirectory	Deletes a directory (inside a Workspace) and all of its contents.	Request object method variants only take one parameter, a request object, which must be constructed before the call. removeDirectory(RemoveDirectoryRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeDirectoryCallable()
MoveDirectory	Moves a directory (inside a Workspace), and all of its contents, to a new location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. moveDirectory(MoveDirectoryRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. moveDirectoryCallable()
ReadFile	Returns the contents of a file (inside a Workspace).	Request object method variants only take one parameter, a request object, which must be constructed before the call. readFile(ReadFileRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. readFileCallable()
RemoveFile	Deletes a file (inside a Workspace).	Request object method variants only take one parameter, a request object, which must be constructed before the call. removeFile(RemoveFileRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeFileCallable()
MoveFile	Moves a file (inside a Workspace) to a new location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. moveFile(MoveFileRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. moveFileCallable()
WriteFile	Writes to a file (inside a Workspace).	Request object method variants only take one parameter, a request object, which must be constructed before the call. writeFile(WriteFileRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. writeFileCallable()
ListReleaseConfigs	Lists ReleaseConfigs in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listReleaseConfigs(ListReleaseConfigsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listReleaseConfigs(RepositoryName parent) listReleaseConfigs(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listReleaseConfigsPagedCallable() listReleaseConfigsCallable()
GetReleaseConfig	Fetches a single ReleaseConfig.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getReleaseConfig(GetReleaseConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getReleaseConfig(ReleaseConfigName name) getReleaseConfig(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getReleaseConfigCallable()
CreateReleaseConfig	Creates a new ReleaseConfig in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createReleaseConfig(CreateReleaseConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createReleaseConfig(RepositoryName parent, ReleaseConfig releaseConfig, String releaseConfigId) createReleaseConfig(String parent, ReleaseConfig releaseConfig, String releaseConfigId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createReleaseConfigCallable()
UpdateReleaseConfig	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.*	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateReleaseConfig(UpdateReleaseConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateReleaseConfig(ReleaseConfig releaseConfig, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateReleaseConfigCallable()
DeleteReleaseConfig	Deletes a single ReleaseConfig.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteReleaseConfig(DeleteReleaseConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteReleaseConfig(ReleaseConfigName name) deleteReleaseConfig(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteReleaseConfigCallable()
ListCompilationResults	Lists CompilationResults in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCompilationResults(ListCompilationResultsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCompilationResults(RepositoryName parent) listCompilationResults(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCompilationResultsPagedCallable() listCompilationResultsCallable()
GetCompilationResult	Fetches a single CompilationResult.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCompilationResult(GetCompilationResultRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCompilationResult(CompilationResultName name) getCompilationResult(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCompilationResultCallable()
CreateCompilationResult	Creates a new CompilationResult in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createCompilationResult(CreateCompilationResultRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createCompilationResult(RepositoryName parent, CompilationResult compilationResult) createCompilationResult(String parent, CompilationResult compilationResult) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createCompilationResultCallable()
QueryCompilationResultActions	Returns CompilationResultActions in a given CompilationResult.	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryCompilationResultActions(QueryCompilationResultActionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryCompilationResultActionsPagedCallable() queryCompilationResultActionsCallable()
ListWorkflowConfigs	Lists WorkflowConfigs in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listWorkflowConfigs(ListWorkflowConfigsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listWorkflowConfigs(RepositoryName parent) listWorkflowConfigs(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listWorkflowConfigsPagedCallable() listWorkflowConfigsCallable()
GetWorkflowConfig	Fetches a single WorkflowConfig.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getWorkflowConfig(GetWorkflowConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getWorkflowConfig(WorkflowConfigName name) getWorkflowConfig(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getWorkflowConfigCallable()
CreateWorkflowConfig	Creates a new WorkflowConfig in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createWorkflowConfig(CreateWorkflowConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createWorkflowConfig(RepositoryName parent, WorkflowConfig workflowConfig, String workflowConfigId) createWorkflowConfig(String parent, WorkflowConfig workflowConfig, String workflowConfigId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createWorkflowConfigCallable()
UpdateWorkflowConfig	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.*	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateWorkflowConfig(UpdateWorkflowConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateWorkflowConfig(WorkflowConfig workflowConfig, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateWorkflowConfigCallable()
DeleteWorkflowConfig	Deletes a single WorkflowConfig.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteWorkflowConfig(DeleteWorkflowConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteWorkflowConfig(WorkflowConfigName name) deleteWorkflowConfig(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteWorkflowConfigCallable()
ListWorkflowInvocations	Lists WorkflowInvocations in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listWorkflowInvocations(ListWorkflowInvocationsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listWorkflowInvocations(RepositoryName parent) listWorkflowInvocations(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listWorkflowInvocationsPagedCallable() listWorkflowInvocationsCallable()
GetWorkflowInvocation	Fetches a single WorkflowInvocation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getWorkflowInvocation(GetWorkflowInvocationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getWorkflowInvocation(WorkflowInvocationName name) getWorkflowInvocation(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getWorkflowInvocationCallable()
CreateWorkflowInvocation	Creates a new WorkflowInvocation in a given Repository.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createWorkflowInvocation(CreateWorkflowInvocationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createWorkflowInvocation(RepositoryName parent, WorkflowInvocation workflowInvocation) createWorkflowInvocation(String parent, WorkflowInvocation workflowInvocation) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createWorkflowInvocationCallable()
DeleteWorkflowInvocation	Deletes a single WorkflowInvocation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteWorkflowInvocation(WorkflowInvocationName name) deleteWorkflowInvocation(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteWorkflowInvocationCallable()
CancelWorkflowInvocation	Requests cancellation of a running WorkflowInvocation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. cancelWorkflowInvocation(CancelWorkflowInvocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. cancelWorkflowInvocationCallable()
QueryWorkflowInvocationActions	Returns WorkflowInvocationActions in a given WorkflowInvocation.	Request object method variants only take one parameter, a request object, which must be constructed before the call. queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. queryWorkflowInvocationActionsPagedCallable() queryWorkflowInvocationActionsCallable()
GetConfig	Get default config for a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getConfig(GetConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getConfig(ConfigName name) getConfig(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getConfigCallable()
UpdateConfig	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.*	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateConfig(UpdateConfigRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateConfig(Config config, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateConfigCallable()
GetIamPolicy	Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getIamPolicy(ResourceName resource) getIamPolicy(String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
SetIamPolicy	Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()
ListLocations	Lists information about the supported locations for this service. This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: *Global locations: If `name` is empty, the method lists thepublic locations available to all projects. * Project-specificlocations: If `name` follows the format`projects/{project}`, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project. For gRPC and client library implementations, the resource name ispassed as the `name` field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DataformSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataformSettings dataformSettings =
     DataformSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataformClient dataformClient = DataformClient.create(dataformSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataformSettings dataformSettings =
     DataformSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataformClient dataformClient = DataformClient.create(dataformSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataformSettings dataformSettings = DataformSettings.newHttpJsonBuilder().build();
 DataformClient dataformClient = DataformClient.create(dataformSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > DataformClient

Static Methods

create()

public static final DataformClient create()

Constructs an instance of DataformClient with default settings.

Returns
Type	Description
`DataformClient`

Exceptions
Type	Description
`IOException`

create(DataformSettings settings)

public static final DataformClient create(DataformSettings settings)

Constructs an instance of DataformClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`DataformSettings`

Returns
Type	Description
`DataformClient`

Exceptions
Type	Description
`IOException`

create(DataformStub stub)

public static final DataformClient create(DataformStub stub)

Constructs an instance of DataformClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataformSettings).

Parameter
Name	Description
`stub`	`DataformStub`

Returns
Type	Description
`DataformClient`

Constructors

DataformClient(DataformSettings settings)

protected DataformClient(DataformSettings settings)

Constructs an instance of DataformClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`DataformSettings`

DataformClient(DataformStub stub)

protected DataformClient(DataformStub stub)

Parameter
Name	Description
`stub`	`DataformStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

cancelWorkflowInvocation(CancelWorkflowInvocationRequest request)

public final CancelWorkflowInvocationResponse cancelWorkflowInvocation(CancelWorkflowInvocationRequest request)

Requests cancellation of a running WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CancelWorkflowInvocationRequest request =
       CancelWorkflowInvocationRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .build();
   CancelWorkflowInvocationResponse response = dataformClient.cancelWorkflowInvocation(request);
 }

Parameter
Name	Description
`request`	`CancelWorkflowInvocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CancelWorkflowInvocationResponse`

cancelWorkflowInvocationCallable()

public final UnaryCallable<CancelWorkflowInvocationRequest,CancelWorkflowInvocationResponse> cancelWorkflowInvocationCallable()

Requests cancellation of a running WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CancelWorkflowInvocationRequest request =
       CancelWorkflowInvocationRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .build();
   ApiFuture<CancelWorkflowInvocationResponse> future =
       dataformClient.cancelWorkflowInvocationCallable().futureCall(request);
   // Do something.
   CancelWorkflowInvocationResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CancelWorkflowInvocationRequest,CancelWorkflowInvocationResponse>`

close()

public final void close()

commitRepositoryChanges(CommitRepositoryChangesRequest request)

public final CommitRepositoryChangesResponse commitRepositoryChanges(CommitRepositoryChangesRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CommitRepositoryChangesRequest request =
       CommitRepositoryChangesRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCommitMetadata(CommitMetadata.newBuilder().build())
           .setRequiredHeadCommitSha("requiredHeadCommitSha-393901930")
           .putAllFileOperations(
               new HashMap<String, CommitRepositoryChangesRequest.FileOperation>())
           .build();
   CommitRepositoryChangesResponse response = dataformClient.commitRepositoryChanges(request);
 }

Parameter
Name	Description
`request`	`CommitRepositoryChangesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CommitRepositoryChangesResponse`

commitRepositoryChangesCallable()

public final UnaryCallable<CommitRepositoryChangesRequest,CommitRepositoryChangesResponse> commitRepositoryChangesCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CommitRepositoryChangesRequest request =
       CommitRepositoryChangesRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCommitMetadata(CommitMetadata.newBuilder().build())
           .setRequiredHeadCommitSha("requiredHeadCommitSha-393901930")
           .putAllFileOperations(
               new HashMap<String, CommitRepositoryChangesRequest.FileOperation>())
           .build();
   ApiFuture<CommitRepositoryChangesResponse> future =
       dataformClient.commitRepositoryChangesCallable().futureCall(request);
   // Do something.
   CommitRepositoryChangesResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CommitRepositoryChangesRequest,CommitRepositoryChangesResponse>`

commitWorkspaceChanges(CommitWorkspaceChangesRequest request)

public final CommitWorkspaceChangesResponse commitWorkspaceChanges(CommitWorkspaceChangesRequest request)

Applies a Git commit for uncommitted files in a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CommitWorkspaceChangesRequest request =
       CommitWorkspaceChangesRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setAuthor(CommitAuthor.newBuilder().build())
           .setCommitMessage("commitMessage2039804624")
           .addAllPaths(new ArrayList<String>())
           .build();
   CommitWorkspaceChangesResponse response = dataformClient.commitWorkspaceChanges(request);
 }

Parameter
Name	Description
`request`	`CommitWorkspaceChangesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CommitWorkspaceChangesResponse`

commitWorkspaceChangesCallable()

public final UnaryCallable<CommitWorkspaceChangesRequest,CommitWorkspaceChangesResponse> commitWorkspaceChangesCallable()

Applies a Git commit for uncommitted files in a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CommitWorkspaceChangesRequest request =
       CommitWorkspaceChangesRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setAuthor(CommitAuthor.newBuilder().build())
           .setCommitMessage("commitMessage2039804624")
           .addAllPaths(new ArrayList<String>())
           .build();
   ApiFuture<CommitWorkspaceChangesResponse> future =
       dataformClient.commitWorkspaceChangesCallable().futureCall(request);
   // Do something.
   CommitWorkspaceChangesResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CommitWorkspaceChangesRequest,CommitWorkspaceChangesResponse>`

computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request)

public final ComputeRepositoryAccessTokenStatusResponse computeRepositoryAccessTokenStatus(ComputeRepositoryAccessTokenStatusRequest request)

Computes a Repository's Git access token status.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ComputeRepositoryAccessTokenStatusRequest request =
       ComputeRepositoryAccessTokenStatusRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   ComputeRepositoryAccessTokenStatusResponse response =
       dataformClient.computeRepositoryAccessTokenStatus(request);
 }

Parameter
Name	Description
`request`	`ComputeRepositoryAccessTokenStatusRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ComputeRepositoryAccessTokenStatusResponse`

computeRepositoryAccessTokenStatusCallable()

public final UnaryCallable<ComputeRepositoryAccessTokenStatusRequest,ComputeRepositoryAccessTokenStatusResponse> computeRepositoryAccessTokenStatusCallable()

Computes a Repository's Git access token status.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ComputeRepositoryAccessTokenStatusRequest request =
       ComputeRepositoryAccessTokenStatusRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   ApiFuture<ComputeRepositoryAccessTokenStatusResponse> future =
       dataformClient.computeRepositoryAccessTokenStatusCallable().futureCall(request);
   // Do something.
   ComputeRepositoryAccessTokenStatusResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ComputeRepositoryAccessTokenStatusRequest,ComputeRepositoryAccessTokenStatusResponse>`

createCompilationResult(@Nullable RepositoryName parent, CompilationResult compilationResult)

public final CompilationResult createCompilationResult(@Nullable RepositoryName parent, CompilationResult compilationResult)

Creates a new CompilationResult in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   CompilationResult compilationResult = CompilationResult.newBuilder().build();
   CompilationResult response =
       dataformClient.createCompilationResult(parent, compilationResult);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to create the compilation result. Must be in the format `projects//locations//repositories/*`.
`compilationResult`	`CompilationResult` Required. The compilation result to create.

Returns
Type	Description
`CompilationResult`

createCompilationResult(CreateCompilationResultRequest request)

public final CompilationResult createCompilationResult(CreateCompilationResultRequest request)

Creates a new CompilationResult in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateCompilationResultRequest request =
       CreateCompilationResultRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCompilationResult(CompilationResult.newBuilder().build())
           .build();
   CompilationResult response = dataformClient.createCompilationResult(request);
 }

Parameter
Name	Description
`request`	`CreateCompilationResultRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CompilationResult`

createCompilationResult(String parent, CompilationResult compilationResult)

public final CompilationResult createCompilationResult(String parent, CompilationResult compilationResult)

Creates a new CompilationResult in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   CompilationResult compilationResult = CompilationResult.newBuilder().build();
   CompilationResult response =
       dataformClient.createCompilationResult(parent, compilationResult);
 }

Parameters
Name	Description
`parent`	`String` Required. The repository in which to create the compilation result. Must be in the format `projects//locations//repositories/*`.
`compilationResult`	`CompilationResult` Required. The compilation result to create.

Returns
Type	Description
`CompilationResult`

createCompilationResultCallable()

public final UnaryCallable<CreateCompilationResultRequest,CompilationResult> createCompilationResultCallable()

Creates a new CompilationResult in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateCompilationResultRequest request =
       CreateCompilationResultRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCompilationResult(CompilationResult.newBuilder().build())
           .build();
   ApiFuture<CompilationResult> future =
       dataformClient.createCompilationResultCallable().futureCall(request);
   // Do something.
   CompilationResult response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateCompilationResultRequest,CompilationResult>`

createFolder(@Nullable LocationName parent, Folder folder)

public final Folder createFolder(@Nullable LocationName parent, Folder folder)

Creates a new Folder in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Folder folder = Folder.newBuilder().build();
   Folder response = dataformClient.createFolder(parent, folder);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.LocationName` Required. The location in which to create the Folder. Must be in the format `projects//locations/`.
`folder`	`Folder` Required. The Folder to create.

Returns
Type	Description
`Folder`

createFolder(CreateFolderRequest request)

public final Folder createFolder(CreateFolderRequest request)

Creates a new Folder in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateFolderRequest request =
       CreateFolderRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFolder(Folder.newBuilder().build())
           .build();
   Folder response = dataformClient.createFolder(request);
 }

Parameter
Name	Description
`request`	`CreateFolderRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Folder`

createFolder(String parent, Folder folder)

public final Folder createFolder(String parent, Folder folder)

Creates a new Folder in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Folder folder = Folder.newBuilder().build();
   Folder response = dataformClient.createFolder(parent, folder);
 }

Parameters
Name	Description
`parent`	`String` Required. The location in which to create the Folder. Must be in the format `projects//locations/`.
`folder`	`Folder` Required. The Folder to create.

Returns
Type	Description
`Folder`

createFolderCallable()

public final UnaryCallable<CreateFolderRequest,Folder> createFolderCallable()

Creates a new Folder in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateFolderRequest request =
       CreateFolderRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFolder(Folder.newBuilder().build())
           .build();
   ApiFuture<Folder> future = dataformClient.createFolderCallable().futureCall(request);
   // Do something.
   Folder response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateFolderRequest,Folder>`

createReleaseConfig(@Nullable RepositoryName parent, ReleaseConfig releaseConfig, String releaseConfigId)

public final ReleaseConfig createReleaseConfig(@Nullable RepositoryName parent, ReleaseConfig releaseConfig, String releaseConfigId)

Creates a new ReleaseConfig in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   ReleaseConfig releaseConfig = ReleaseConfig.newBuilder().build();
   String releaseConfigId = "releaseConfigId1350457636";
   ReleaseConfig response =
       dataformClient.createReleaseConfig(parent, releaseConfig, releaseConfigId);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to create the release config. Must be in the format `projects//locations//repositories/*`.
`releaseConfig`	`ReleaseConfig` Required. The release config to create.
`releaseConfigId`	`String` Required. The ID to use for the release config, which will become the final component of the release config's resource name.

Returns
Type	Description
`ReleaseConfig`

createReleaseConfig(CreateReleaseConfigRequest request)

public final ReleaseConfig createReleaseConfig(CreateReleaseConfigRequest request)

Creates a new ReleaseConfig in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateReleaseConfigRequest request =
       CreateReleaseConfigRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setReleaseConfig(ReleaseConfig.newBuilder().build())
           .setReleaseConfigId("releaseConfigId1350457636")
           .build();
   ReleaseConfig response = dataformClient.createReleaseConfig(request);
 }

Parameter
Name	Description
`request`	`CreateReleaseConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ReleaseConfig`

createReleaseConfig(String parent, ReleaseConfig releaseConfig, String releaseConfigId)

public final ReleaseConfig createReleaseConfig(String parent, ReleaseConfig releaseConfig, String releaseConfigId)

Creates a new ReleaseConfig in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   ReleaseConfig releaseConfig = ReleaseConfig.newBuilder().build();
   String releaseConfigId = "releaseConfigId1350457636";
   ReleaseConfig response =
       dataformClient.createReleaseConfig(parent, releaseConfig, releaseConfigId);
 }

Parameters
Name	Description
`parent`	`String` Required. The repository in which to create the release config. Must be in the format `projects//locations//repositories/*`.
`releaseConfig`	`ReleaseConfig` Required. The release config to create.
`releaseConfigId`	`String` Required. The ID to use for the release config, which will become the final component of the release config's resource name.

Returns
Type	Description
`ReleaseConfig`

createReleaseConfigCallable()

public final UnaryCallable<CreateReleaseConfigRequest,ReleaseConfig> createReleaseConfigCallable()

Creates a new ReleaseConfig in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateReleaseConfigRequest request =
       CreateReleaseConfigRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setReleaseConfig(ReleaseConfig.newBuilder().build())
           .setReleaseConfigId("releaseConfigId1350457636")
           .build();
   ApiFuture<ReleaseConfig> future =
       dataformClient.createReleaseConfigCallable().futureCall(request);
   // Do something.
   ReleaseConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateReleaseConfigRequest,ReleaseConfig>`

createRepository(@Nullable LocationName parent, Repository repository, String repositoryId)

public final Repository createRepository(@Nullable LocationName parent, Repository repository, String repositoryId)

Creates a new Repository in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Repository repository = Repository.newBuilder().build();
   String repositoryId = "repositoryId2113747461";
   Repository response = dataformClient.createRepository(parent, repository, repositoryId);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.LocationName` Required. The location in which to create the repository. Must be in the format `projects//locations/`.
`repository`	`Repository` Required. The repository to create.
`repositoryId`	`String` Required. The ID to use for the repository, which will become the final component of the repository's resource name.

Returns
Type	Description
`Repository`

createRepository(CreateRepositoryRequest request)

public final Repository createRepository(CreateRepositoryRequest request)

Creates a new Repository in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateRepositoryRequest request =
       CreateRepositoryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRepository(Repository.newBuilder().build())
           .setRepositoryId("repositoryId2113747461")
           .build();
   Repository response = dataformClient.createRepository(request);
 }

Parameter
Name	Description
`request`	`CreateRepositoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Repository`

createRepository(String parent, Repository repository, String repositoryId)

public final Repository createRepository(String parent, Repository repository, String repositoryId)

Creates a new Repository in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Repository repository = Repository.newBuilder().build();
   String repositoryId = "repositoryId2113747461";
   Repository response = dataformClient.createRepository(parent, repository, repositoryId);
 }

Parameters
Name	Description
`parent`	`String` Required. The location in which to create the repository. Must be in the format `projects//locations/`.
`repository`	`Repository` Required. The repository to create.
`repositoryId`	`String` Required. The ID to use for the repository, which will become the final component of the repository's resource name.

Returns
Type	Description
`Repository`

createRepositoryCallable()

public final UnaryCallable<CreateRepositoryRequest,Repository> createRepositoryCallable()

Creates a new Repository in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateRepositoryRequest request =
       CreateRepositoryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRepository(Repository.newBuilder().build())
           .setRepositoryId("repositoryId2113747461")
           .build();
   ApiFuture<Repository> future = dataformClient.createRepositoryCallable().futureCall(request);
   // Do something.
   Repository response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateRepositoryRequest,Repository>`

createTeamFolder(@Nullable LocationName parent, TeamFolder teamFolder)

public final TeamFolder createTeamFolder(@Nullable LocationName parent, TeamFolder teamFolder)

Creates a new TeamFolder in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   TeamFolder teamFolder = TeamFolder.newBuilder().build();
   TeamFolder response = dataformClient.createTeamFolder(parent, teamFolder);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.LocationName` Required. The location in which to create the TeamFolder. Must be in the format `projects//locations/`.
`teamFolder`	`TeamFolder` Required. The TeamFolder to create.

Returns
Type	Description
`TeamFolder`

createTeamFolder(CreateTeamFolderRequest request)

public final TeamFolder createTeamFolder(CreateTeamFolderRequest request)

Creates a new TeamFolder in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateTeamFolderRequest request =
       CreateTeamFolderRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTeamFolder(TeamFolder.newBuilder().build())
           .build();
   TeamFolder response = dataformClient.createTeamFolder(request);
 }

Parameter
Name	Description
`request`	`CreateTeamFolderRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TeamFolder`

createTeamFolder(String parent, TeamFolder teamFolder)

public final TeamFolder createTeamFolder(String parent, TeamFolder teamFolder)

Creates a new TeamFolder in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   TeamFolder teamFolder = TeamFolder.newBuilder().build();
   TeamFolder response = dataformClient.createTeamFolder(parent, teamFolder);
 }

Parameters
Name	Description
`parent`	`String` Required. The location in which to create the TeamFolder. Must be in the format `projects//locations/`.
`teamFolder`	`TeamFolder` Required. The TeamFolder to create.

Returns
Type	Description
`TeamFolder`

createTeamFolderCallable()

public final UnaryCallable<CreateTeamFolderRequest,TeamFolder> createTeamFolderCallable()

Creates a new TeamFolder in a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateTeamFolderRequest request =
       CreateTeamFolderRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setTeamFolder(TeamFolder.newBuilder().build())
           .build();
   ApiFuture<TeamFolder> future = dataformClient.createTeamFolderCallable().futureCall(request);
   // Do something.
   TeamFolder response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateTeamFolderRequest,TeamFolder>`

createWorkflowConfig(@Nullable RepositoryName parent, WorkflowConfig workflowConfig, String workflowConfigId)

public final WorkflowConfig createWorkflowConfig(@Nullable RepositoryName parent, WorkflowConfig workflowConfig, String workflowConfigId)

Creates a new WorkflowConfig in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   WorkflowConfig workflowConfig = WorkflowConfig.newBuilder().build();
   String workflowConfigId = "workflowConfigId-1331048228";
   WorkflowConfig response =
       dataformClient.createWorkflowConfig(parent, workflowConfig, workflowConfigId);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to create the workflow config. Must be in the format `projects//locations//repositories/*`.
`workflowConfig`	`WorkflowConfig` Required. The workflow config to create.
`workflowConfigId`	`String` Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.

Returns
Type	Description
`WorkflowConfig`

createWorkflowConfig(CreateWorkflowConfigRequest request)

public final WorkflowConfig createWorkflowConfig(CreateWorkflowConfigRequest request)

Creates a new WorkflowConfig in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateWorkflowConfigRequest request =
       CreateWorkflowConfigRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setWorkflowConfig(WorkflowConfig.newBuilder().build())
           .setWorkflowConfigId("workflowConfigId-1331048228")
           .build();
   WorkflowConfig response = dataformClient.createWorkflowConfig(request);
 }

Parameter
Name	Description
`request`	`CreateWorkflowConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`WorkflowConfig`

createWorkflowConfig(String parent, WorkflowConfig workflowConfig, String workflowConfigId)

public final WorkflowConfig createWorkflowConfig(String parent, WorkflowConfig workflowConfig, String workflowConfigId)

Creates a new WorkflowConfig in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   WorkflowConfig workflowConfig = WorkflowConfig.newBuilder().build();
   String workflowConfigId = "workflowConfigId-1331048228";
   WorkflowConfig response =
       dataformClient.createWorkflowConfig(parent, workflowConfig, workflowConfigId);
 }

Parameters
Name	Description
`parent`	`String` Required. The repository in which to create the workflow config. Must be in the format `projects//locations//repositories/*`.
`workflowConfig`	`WorkflowConfig` Required. The workflow config to create.
`workflowConfigId`	`String` Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.

Returns
Type	Description
`WorkflowConfig`

createWorkflowConfigCallable()

public final UnaryCallable<CreateWorkflowConfigRequest,WorkflowConfig> createWorkflowConfigCallable()

Creates a new WorkflowConfig in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateWorkflowConfigRequest request =
       CreateWorkflowConfigRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setWorkflowConfig(WorkflowConfig.newBuilder().build())
           .setWorkflowConfigId("workflowConfigId-1331048228")
           .build();
   ApiFuture<WorkflowConfig> future =
       dataformClient.createWorkflowConfigCallable().futureCall(request);
   // Do something.
   WorkflowConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateWorkflowConfigRequest,WorkflowConfig>`

createWorkflowInvocation(@Nullable RepositoryName parent, WorkflowInvocation workflowInvocation)

public final WorkflowInvocation createWorkflowInvocation(@Nullable RepositoryName parent, WorkflowInvocation workflowInvocation)

Creates a new WorkflowInvocation in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   WorkflowInvocation workflowInvocation = WorkflowInvocation.newBuilder().build();
   WorkflowInvocation response =
       dataformClient.createWorkflowInvocation(parent, workflowInvocation);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to create the workflow invocation. Must be in the format `projects//locations//repositories/*`.
`workflowInvocation`	`WorkflowInvocation` Required. The workflow invocation resource to create.

Returns
Type	Description
`WorkflowInvocation`

createWorkflowInvocation(CreateWorkflowInvocationRequest request)

public final WorkflowInvocation createWorkflowInvocation(CreateWorkflowInvocationRequest request)

Creates a new WorkflowInvocation in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateWorkflowInvocationRequest request =
       CreateWorkflowInvocationRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setWorkflowInvocation(WorkflowInvocation.newBuilder().build())
           .build();
   WorkflowInvocation response = dataformClient.createWorkflowInvocation(request);
 }

Parameter
Name	Description
`request`	`CreateWorkflowInvocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`WorkflowInvocation`

createWorkflowInvocation(String parent, WorkflowInvocation workflowInvocation)

public final WorkflowInvocation createWorkflowInvocation(String parent, WorkflowInvocation workflowInvocation)

Creates a new WorkflowInvocation in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   WorkflowInvocation workflowInvocation = WorkflowInvocation.newBuilder().build();
   WorkflowInvocation response =
       dataformClient.createWorkflowInvocation(parent, workflowInvocation);
 }

Parameters
Name	Description
`parent`	`String` Required. The repository in which to create the workflow invocation. Must be in the format `projects//locations//repositories/*`.
`workflowInvocation`	`WorkflowInvocation` Required. The workflow invocation resource to create.

Returns
Type	Description
`WorkflowInvocation`

createWorkflowInvocationCallable()

public final UnaryCallable<CreateWorkflowInvocationRequest,WorkflowInvocation> createWorkflowInvocationCallable()

Creates a new WorkflowInvocation in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateWorkflowInvocationRequest request =
       CreateWorkflowInvocationRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setWorkflowInvocation(WorkflowInvocation.newBuilder().build())
           .build();
   ApiFuture<WorkflowInvocation> future =
       dataformClient.createWorkflowInvocationCallable().futureCall(request);
   // Do something.
   WorkflowInvocation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateWorkflowInvocationRequest,WorkflowInvocation>`

createWorkspace(@Nullable RepositoryName parent, Workspace workspace, String workspaceId)

public final Workspace createWorkspace(@Nullable RepositoryName parent, Workspace workspace, String workspaceId)

Creates a new Workspace in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   Workspace workspace = Workspace.newBuilder().build();
   String workspaceId = "workspaceId466560144";
   Workspace response = dataformClient.createWorkspace(parent, workspace, workspaceId);
 }

Parameters
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to create the workspace. Must be in the format `projects//locations//repositories/*`.
`workspace`	`Workspace` Required. The workspace to create.
`workspaceId`	`String` Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.

Returns
Type	Description
`Workspace`

createWorkspace(CreateWorkspaceRequest request)

public final Workspace createWorkspace(CreateWorkspaceRequest request)

Creates a new Workspace in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateWorkspaceRequest request =
       CreateWorkspaceRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setWorkspace(Workspace.newBuilder().build())
           .setWorkspaceId("workspaceId466560144")
           .build();
   Workspace response = dataformClient.createWorkspace(request);
 }

Parameter
Name	Description
`request`	`CreateWorkspaceRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Workspace`

createWorkspace(String parent, Workspace workspace, String workspaceId)

public final Workspace createWorkspace(String parent, Workspace workspace, String workspaceId)

Creates a new Workspace in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   Workspace workspace = Workspace.newBuilder().build();
   String workspaceId = "workspaceId466560144";
   Workspace response = dataformClient.createWorkspace(parent, workspace, workspaceId);
 }

Parameters
Name	Description
`parent`	`String` Required. The repository in which to create the workspace. Must be in the format `projects//locations//repositories/*`.
`workspace`	`Workspace` Required. The workspace to create.
`workspaceId`	`String` Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.

Returns
Type	Description
`Workspace`

createWorkspaceCallable()

public final UnaryCallable<CreateWorkspaceRequest,Workspace> createWorkspaceCallable()

Creates a new Workspace in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CreateWorkspaceRequest request =
       CreateWorkspaceRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setWorkspace(Workspace.newBuilder().build())
           .setWorkspaceId("workspaceId466560144")
           .build();
   ApiFuture<Workspace> future = dataformClient.createWorkspaceCallable().futureCall(request);
   // Do something.
   Workspace response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateWorkspaceRequest,Workspace>`

deleteFolder(@Nullable FolderName name)

public final void deleteFolder(@Nullable FolderName name)

Deletes a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FolderName name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]");
   dataformClient.deleteFolder(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.FolderName` Required. The Folder's name.

deleteFolder(DeleteFolderRequest request)

public final void deleteFolder(DeleteFolderRequest request)

Deletes a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteFolderRequest request =
       DeleteFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .build();
   dataformClient.deleteFolder(request);
 }

Parameter
Name	Description
`request`	`DeleteFolderRequest` The request object containing all of the parameters for the API call.

deleteFolder(String name)

public final void deleteFolder(String name)

Deletes a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString();
   dataformClient.deleteFolder(name);
 }

Parameter
Name	Description
`name`	`String` Required. The Folder's name.

deleteFolderCallable()

public final UnaryCallable<DeleteFolderRequest,Empty> deleteFolderCallable()

Deletes a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteFolderRequest request =
       DeleteFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .build();
   ApiFuture<Empty> future = dataformClient.deleteFolderCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteFolderRequest,Empty>`

deleteFolderTreeAsync(@Nullable FolderName name, boolean force)

public final OperationFuture<Empty,DeleteFolderTreeMetadata> deleteFolderTreeAsync(@Nullable FolderName name, boolean force)

Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FolderName name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]");
   boolean force = true;
   dataformClient.deleteFolderTreeAsync(name, force).get();
 }

Parameters

Name Description

name

@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.FolderName

Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder}

force

boolean

Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

If true: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.

Returns
Type	Description
`OperationFuture<Empty,DeleteFolderTreeMetadata>`

deleteFolderTreeAsync(DeleteFolderTreeRequest request)

public final OperationFuture<Empty,DeleteFolderTreeMetadata> deleteFolderTreeAsync(DeleteFolderTreeRequest request)

Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteFolderTreeRequest request =
       DeleteFolderTreeRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setForce(true)
           .build();
   dataformClient.deleteFolderTreeAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteFolderTreeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,DeleteFolderTreeMetadata>`

deleteFolderTreeAsync(String name, boolean force)

public final OperationFuture<Empty,DeleteFolderTreeMetadata> deleteFolderTreeAsync(String name, boolean force)

Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString();
   boolean force = true;
   dataformClient.deleteFolderTreeAsync(name, force).get();
 }

Parameters

Name Description

name

String

Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder}

force

boolean

Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

Returns
Type	Description
`OperationFuture<Empty,DeleteFolderTreeMetadata>`

deleteFolderTreeCallable()

public final UnaryCallable<DeleteFolderTreeRequest,Operation> deleteFolderTreeCallable()

Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteFolderTreeRequest request =
       DeleteFolderTreeRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setForce(true)
           .build();
   ApiFuture<Operation> future = dataformClient.deleteFolderTreeCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteFolderTreeRequest,Operation>`

deleteFolderTreeOperationCallable()

public final OperationCallable<DeleteFolderTreeRequest,Empty,DeleteFolderTreeMetadata> deleteFolderTreeOperationCallable()

Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteFolderTreeRequest request =
       DeleteFolderTreeRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setForce(true)
           .build();
   OperationFuture<Empty, DeleteFolderTreeMetadata> future =
       dataformClient.deleteFolderTreeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteFolderTreeRequest,Empty,DeleteFolderTreeMetadata>`

deleteReleaseConfig(@Nullable ReleaseConfigName name)

public final void deleteReleaseConfig(@Nullable ReleaseConfigName name)

Deletes a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ReleaseConfigName name =
       ReleaseConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]");
   dataformClient.deleteReleaseConfig(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.ReleaseConfigName` Required. The release config's name.

deleteReleaseConfig(DeleteReleaseConfigRequest request)

public final void deleteReleaseConfig(DeleteReleaseConfigRequest request)

Deletes a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteReleaseConfigRequest request =
       DeleteReleaseConfigRequest.newBuilder()
           .setName(
               ReleaseConfigName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]")
                   .toString())
           .build();
   dataformClient.deleteReleaseConfig(request);
 }

Parameter
Name	Description
`request`	`DeleteReleaseConfigRequest` The request object containing all of the parameters for the API call.

deleteReleaseConfig(String name)

public final void deleteReleaseConfig(String name)

Deletes a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       ReleaseConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]")
           .toString();
   dataformClient.deleteReleaseConfig(name);
 }

Parameter
Name	Description
`name`	`String` Required. The release config's name.

deleteReleaseConfigCallable()

public final UnaryCallable<DeleteReleaseConfigRequest,Empty> deleteReleaseConfigCallable()

Deletes a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteReleaseConfigRequest request =
       DeleteReleaseConfigRequest.newBuilder()
           .setName(
               ReleaseConfigName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]")
                   .toString())
           .build();
   ApiFuture<Empty> future = dataformClient.deleteReleaseConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteReleaseConfigRequest,Empty>`

deleteRepository(@Nullable RepositoryName name)

public final void deleteRepository(@Nullable RepositoryName name)

Deletes a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   dataformClient.deleteRepository(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository's name.

deleteRepository(DeleteRepositoryRequest request)

public final void deleteRepository(DeleteRepositoryRequest request)

Deletes a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteRepositoryRequest request =
       DeleteRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setForce(true)
           .build();
   dataformClient.deleteRepository(request);
 }

Parameter
Name	Description
`request`	`DeleteRepositoryRequest` The request object containing all of the parameters for the API call.

deleteRepository(String name)

public final void deleteRepository(String name)

Deletes a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   dataformClient.deleteRepository(name);
 }

Parameter
Name	Description
`name`	`String` Required. The repository's name.

deleteRepositoryCallable()

public final UnaryCallable<DeleteRepositoryRequest,Empty> deleteRepositoryCallable()

Deletes a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteRepositoryRequest request =
       DeleteRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setForce(true)
           .build();
   ApiFuture<Empty> future = dataformClient.deleteRepositoryCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteRepositoryRequest,Empty>`

deleteTeamFolder(@Nullable TeamFolderName name)

public final void deleteTeamFolder(@Nullable TeamFolderName name)

Deletes a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   TeamFolderName name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]");
   dataformClient.deleteTeamFolder(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.TeamFolderName` Required. The TeamFolder's name.

deleteTeamFolder(DeleteTeamFolderRequest request)

public final void deleteTeamFolder(DeleteTeamFolderRequest request)

Deletes a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteTeamFolderRequest request =
       DeleteTeamFolderRequest.newBuilder()
           .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .build();
   dataformClient.deleteTeamFolder(request);
 }

Parameter
Name	Description
`request`	`DeleteTeamFolderRequest` The request object containing all of the parameters for the API call.

deleteTeamFolder(String name)

public final void deleteTeamFolder(String name)

Deletes a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString();
   dataformClient.deleteTeamFolder(name);
 }

Parameter
Name	Description
`name`	`String` Required. The TeamFolder's name.

deleteTeamFolderCallable()

public final UnaryCallable<DeleteTeamFolderRequest,Empty> deleteTeamFolderCallable()

Deletes a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteTeamFolderRequest request =
       DeleteTeamFolderRequest.newBuilder()
           .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .build();
   ApiFuture<Empty> future = dataformClient.deleteTeamFolderCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteTeamFolderRequest,Empty>`

deleteTeamFolderTreeAsync(@Nullable TeamFolderName name, boolean force)

public final OperationFuture<Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeAsync(@Nullable TeamFolderName name, boolean force)

Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   TeamFolderName name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]");
   boolean force = true;
   dataformClient.deleteTeamFolderTreeAsync(name, force).get();
 }

Parameters

Name Description

name

@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.TeamFolderName

Required. The TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder}

force

boolean

Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

Returns
Type	Description
`OperationFuture<Empty,DeleteFolderTreeMetadata>`

deleteTeamFolderTreeAsync(DeleteTeamFolderTreeRequest request)

public final OperationFuture<Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeAsync(DeleteTeamFolderTreeRequest request)

Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteTeamFolderTreeRequest request =
       DeleteTeamFolderTreeRequest.newBuilder()
           .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .setForce(true)
           .build();
   dataformClient.deleteTeamFolderTreeAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteTeamFolderTreeRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,DeleteFolderTreeMetadata>`

deleteTeamFolderTreeAsync(String name, boolean force)

public final OperationFuture<Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeAsync(String name, boolean force)

Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString();
   boolean force = true;
   dataformClient.deleteTeamFolderTreeAsync(name, force).get();
 }

Parameters

Name Description

name

String

Required. The TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder}

force

boolean

Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

Returns
Type	Description
`OperationFuture<Empty,DeleteFolderTreeMetadata>`

deleteTeamFolderTreeCallable()

public final UnaryCallable<DeleteTeamFolderTreeRequest,Operation> deleteTeamFolderTreeCallable()

Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteTeamFolderTreeRequest request =
       DeleteTeamFolderTreeRequest.newBuilder()
           .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .setForce(true)
           .build();
   ApiFuture<Operation> future =
       dataformClient.deleteTeamFolderTreeCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteTeamFolderTreeRequest,Operation>`

deleteTeamFolderTreeOperationCallable()

public final OperationCallable<DeleteTeamFolderTreeRequest,Empty,DeleteFolderTreeMetadata> deleteTeamFolderTreeOperationCallable()

Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteTeamFolderTreeRequest request =
       DeleteTeamFolderTreeRequest.newBuilder()
           .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .setForce(true)
           .build();
   OperationFuture<Empty, DeleteFolderTreeMetadata> future =
       dataformClient.deleteTeamFolderTreeOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<DeleteTeamFolderTreeRequest,Empty,DeleteFolderTreeMetadata>`

deleteWorkflowConfig(@Nullable WorkflowConfigName name)

public final void deleteWorkflowConfig(@Nullable WorkflowConfigName name)

Deletes a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WorkflowConfigName name =
       WorkflowConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]");
   dataformClient.deleteWorkflowConfig(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.WorkflowConfigName` Required. The workflow config's name.

deleteWorkflowConfig(DeleteWorkflowConfigRequest request)

public final void deleteWorkflowConfig(DeleteWorkflowConfigRequest request)

Deletes a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteWorkflowConfigRequest request =
       DeleteWorkflowConfigRequest.newBuilder()
           .setName(
               WorkflowConfigName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]")
                   .toString())
           .build();
   dataformClient.deleteWorkflowConfig(request);
 }

Parameter
Name	Description
`request`	`DeleteWorkflowConfigRequest` The request object containing all of the parameters for the API call.

deleteWorkflowConfig(String name)

public final void deleteWorkflowConfig(String name)

Deletes a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       WorkflowConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]")
           .toString();
   dataformClient.deleteWorkflowConfig(name);
 }

Parameter
Name	Description
`name`	`String` Required. The workflow config's name.

deleteWorkflowConfigCallable()

public final UnaryCallable<DeleteWorkflowConfigRequest,Empty> deleteWorkflowConfigCallable()

Deletes a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteWorkflowConfigRequest request =
       DeleteWorkflowConfigRequest.newBuilder()
           .setName(
               WorkflowConfigName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]")
                   .toString())
           .build();
   ApiFuture<Empty> future = dataformClient.deleteWorkflowConfigCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteWorkflowConfigRequest,Empty>`

deleteWorkflowInvocation(@Nullable WorkflowInvocationName name)

public final void deleteWorkflowInvocation(@Nullable WorkflowInvocationName name)

Deletes a single WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WorkflowInvocationName name =
       WorkflowInvocationName.of(
           "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]");
   dataformClient.deleteWorkflowInvocation(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.WorkflowInvocationName` Required. The workflow invocation resource's name.

deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request)

public final void deleteWorkflowInvocation(DeleteWorkflowInvocationRequest request)

Deletes a single WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteWorkflowInvocationRequest request =
       DeleteWorkflowInvocationRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .build();
   dataformClient.deleteWorkflowInvocation(request);
 }

Parameter
Name	Description
`request`	`DeleteWorkflowInvocationRequest` The request object containing all of the parameters for the API call.

deleteWorkflowInvocation(String name)

public final void deleteWorkflowInvocation(String name)

Deletes a single WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       WorkflowInvocationName.of(
               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
           .toString();
   dataformClient.deleteWorkflowInvocation(name);
 }

Parameter
Name	Description
`name`	`String` Required. The workflow invocation resource's name.

deleteWorkflowInvocationCallable()

public final UnaryCallable<DeleteWorkflowInvocationRequest,Empty> deleteWorkflowInvocationCallable()

Deletes a single WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteWorkflowInvocationRequest request =
       DeleteWorkflowInvocationRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       dataformClient.deleteWorkflowInvocationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteWorkflowInvocationRequest,Empty>`

deleteWorkspace(@Nullable WorkspaceName name)

public final void deleteWorkspace(@Nullable WorkspaceName name)

Deletes a single Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WorkspaceName name =
       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]");
   dataformClient.deleteWorkspace(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.WorkspaceName` Required. The workspace resource's name.

deleteWorkspace(DeleteWorkspaceRequest request)

public final void deleteWorkspace(DeleteWorkspaceRequest request)

Deletes a single Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteWorkspaceRequest request =
       DeleteWorkspaceRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .build();
   dataformClient.deleteWorkspace(request);
 }

Parameter
Name	Description
`request`	`DeleteWorkspaceRequest` The request object containing all of the parameters for the API call.

deleteWorkspace(String name)

public final void deleteWorkspace(String name)

Deletes a single Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]").toString();
   dataformClient.deleteWorkspace(name);
 }

Parameter
Name	Description
`name`	`String` Required. The workspace resource's name.

deleteWorkspaceCallable()

public final UnaryCallable<DeleteWorkspaceRequest,Empty> deleteWorkspaceCallable()

Deletes a single Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   DeleteWorkspaceRequest request =
       DeleteWorkspaceRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .build();
   ApiFuture<Empty> future = dataformClient.deleteWorkspaceCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteWorkspaceRequest,Empty>`

fetchFileDiff(FetchFileDiffRequest request)

public final FetchFileDiffResponse fetchFileDiff(FetchFileDiffRequest request)

Fetches Git diff for an uncommitted file in a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchFileDiffRequest request =
       FetchFileDiffRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .build();
   FetchFileDiffResponse response = dataformClient.fetchFileDiff(request);
 }

Parameter
Name	Description
`request`	`FetchFileDiffRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`FetchFileDiffResponse`

fetchFileDiffCallable()

public final UnaryCallable<FetchFileDiffRequest,FetchFileDiffResponse> fetchFileDiffCallable()

Fetches Git diff for an uncommitted file in a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchFileDiffRequest request =
       FetchFileDiffRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .build();
   ApiFuture<FetchFileDiffResponse> future =
       dataformClient.fetchFileDiffCallable().futureCall(request);
   // Do something.
   FetchFileDiffResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<FetchFileDiffRequest,FetchFileDiffResponse>`

fetchFileGitStatuses(FetchFileGitStatusesRequest request)

public final FetchFileGitStatusesResponse fetchFileGitStatuses(FetchFileGitStatusesRequest request)

Fetches Git statuses for the files in a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchFileGitStatusesRequest request =
       FetchFileGitStatusesRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .build();
   FetchFileGitStatusesResponse response = dataformClient.fetchFileGitStatuses(request);
 }

Parameter
Name	Description
`request`	`FetchFileGitStatusesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`FetchFileGitStatusesResponse`

fetchFileGitStatusesCallable()

public final UnaryCallable<FetchFileGitStatusesRequest,FetchFileGitStatusesResponse> fetchFileGitStatusesCallable()

Fetches Git statuses for the files in a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchFileGitStatusesRequest request =
       FetchFileGitStatusesRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .build();
   ApiFuture<FetchFileGitStatusesResponse> future =
       dataformClient.fetchFileGitStatusesCallable().futureCall(request);
   // Do something.
   FetchFileGitStatusesResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<FetchFileGitStatusesRequest,FetchFileGitStatusesResponse>`

fetchGitAheadBehind(FetchGitAheadBehindRequest request)

public final FetchGitAheadBehindResponse fetchGitAheadBehind(FetchGitAheadBehindRequest request)

Fetches Git ahead/behind against a remote branch.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchGitAheadBehindRequest request =
       FetchGitAheadBehindRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setRemoteBranch("remoteBranch-533119608")
           .build();
   FetchGitAheadBehindResponse response = dataformClient.fetchGitAheadBehind(request);
 }

Parameter
Name	Description
`request`	`FetchGitAheadBehindRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`FetchGitAheadBehindResponse`

fetchGitAheadBehindCallable()

public final UnaryCallable<FetchGitAheadBehindRequest,FetchGitAheadBehindResponse> fetchGitAheadBehindCallable()

Fetches Git ahead/behind against a remote branch.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchGitAheadBehindRequest request =
       FetchGitAheadBehindRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setRemoteBranch("remoteBranch-533119608")
           .build();
   ApiFuture<FetchGitAheadBehindResponse> future =
       dataformClient.fetchGitAheadBehindCallable().futureCall(request);
   // Do something.
   FetchGitAheadBehindResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<FetchGitAheadBehindRequest,FetchGitAheadBehindResponse>`

fetchRemoteBranches(FetchRemoteBranchesRequest request)

public final FetchRemoteBranchesResponse fetchRemoteBranches(FetchRemoteBranchesRequest request)

Fetches a Repository's remote branches.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchRemoteBranchesRequest request =
       FetchRemoteBranchesRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   FetchRemoteBranchesResponse response = dataformClient.fetchRemoteBranches(request);
 }

Parameter
Name	Description
`request`	`FetchRemoteBranchesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`FetchRemoteBranchesResponse`

fetchRemoteBranchesCallable()

public final UnaryCallable<FetchRemoteBranchesRequest,FetchRemoteBranchesResponse> fetchRemoteBranchesCallable()

Fetches a Repository's remote branches.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchRemoteBranchesRequest request =
       FetchRemoteBranchesRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   ApiFuture<FetchRemoteBranchesResponse> future =
       dataformClient.fetchRemoteBranchesCallable().futureCall(request);
   // Do something.
   FetchRemoteBranchesResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<FetchRemoteBranchesRequest,FetchRemoteBranchesResponse>`

fetchRepositoryHistory(FetchRepositoryHistoryRequest request)

public final DataformClient.FetchRepositoryHistoryPagedResponse fetchRepositoryHistory(FetchRepositoryHistoryRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchRepositoryHistoryRequest request =
       FetchRepositoryHistoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CommitLogEntry element : dataformClient.fetchRepositoryHistory(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`FetchRepositoryHistoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.FetchRepositoryHistoryPagedResponse`

fetchRepositoryHistoryCallable()

public final UnaryCallable<FetchRepositoryHistoryRequest,FetchRepositoryHistoryResponse> fetchRepositoryHistoryCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchRepositoryHistoryRequest request =
       FetchRepositoryHistoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     FetchRepositoryHistoryResponse response =
         dataformClient.fetchRepositoryHistoryCallable().call(request);
     for (CommitLogEntry element : response.getCommitsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<FetchRepositoryHistoryRequest,FetchRepositoryHistoryResponse>`

fetchRepositoryHistoryPagedCallable()

public final UnaryCallable<FetchRepositoryHistoryRequest,DataformClient.FetchRepositoryHistoryPagedResponse> fetchRepositoryHistoryPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FetchRepositoryHistoryRequest request =
       FetchRepositoryHistoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CommitLogEntry> future =
       dataformClient.fetchRepositoryHistoryPagedCallable().futureCall(request);
   // Do something.
   for (CommitLogEntry element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<FetchRepositoryHistoryRequest,FetchRepositoryHistoryPagedResponse>`

getCompilationResult(@Nullable CompilationResultName name)

public final CompilationResult getCompilationResult(@Nullable CompilationResultName name)

Fetches a single CompilationResult.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   CompilationResultName name =
       CompilationResultName.of(
           "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]");
   CompilationResult response = dataformClient.getCompilationResult(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.CompilationResultName` Required. The compilation result's name.

Returns
Type	Description
`CompilationResult`

getCompilationResult(GetCompilationResultRequest request)

public final CompilationResult getCompilationResult(GetCompilationResultRequest request)

Fetches a single CompilationResult.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetCompilationResultRequest request =
       GetCompilationResultRequest.newBuilder()
           .setName(
               CompilationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                   .toString())
           .build();
   CompilationResult response = dataformClient.getCompilationResult(request);
 }

Parameter
Name	Description
`request`	`GetCompilationResultRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CompilationResult`

getCompilationResult(String name)

public final CompilationResult getCompilationResult(String name)

Fetches a single CompilationResult.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       CompilationResultName.of(
               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
           .toString();
   CompilationResult response = dataformClient.getCompilationResult(name);
 }

Parameter
Name	Description
`name`	`String` Required. The compilation result's name.

Returns
Type	Description
`CompilationResult`

getCompilationResultCallable()

public final UnaryCallable<GetCompilationResultRequest,CompilationResult> getCompilationResultCallable()

Fetches a single CompilationResult.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetCompilationResultRequest request =
       GetCompilationResultRequest.newBuilder()
           .setName(
               CompilationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                   .toString())
           .build();
   ApiFuture<CompilationResult> future =
       dataformClient.getCompilationResultCallable().futureCall(request);
   // Do something.
   CompilationResult response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetCompilationResultRequest,CompilationResult>`

getConfig(@Nullable ConfigName name)

public final Config getConfig(@Nullable ConfigName name)

Get default config for a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ConfigName name = ConfigName.of("[PROJECT]", "[LOCATION]");
   Config response = dataformClient.getConfig(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.ConfigName` Required. The config name.

Returns
Type	Description
`Config`

getConfig(GetConfigRequest request)

public final Config getConfig(GetConfigRequest request)

Get default config for a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetConfigRequest request =
       GetConfigRequest.newBuilder()
           .setName(ConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   Config response = dataformClient.getConfig(request);
 }

Parameter
Name	Description
`request`	`GetConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Config`

getConfig(String name)

public final Config getConfig(String name)

Get default config for a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = ConfigName.of("[PROJECT]", "[LOCATION]").toString();
   Config response = dataformClient.getConfig(name);
 }

Parameter
Name	Description
`name`	`String` Required. The config name.

Returns
Type	Description
`Config`

getConfigCallable()

public final UnaryCallable<GetConfigRequest,Config> getConfigCallable()

Get default config for a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetConfigRequest request =
       GetConfigRequest.newBuilder()
           .setName(ConfigName.of("[PROJECT]", "[LOCATION]").toString())
           .build();
   ApiFuture<Config> future = dataformClient.getConfigCallable().futureCall(request);
   // Do something.
   Config response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetConfigRequest,Config>`

getFolder(@Nullable FolderName name)

public final Folder getFolder(@Nullable FolderName name)

Fetches a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FolderName name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]");
   Folder response = dataformClient.getFolder(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.FolderName` Required. The Folder's name.

Returns
Type	Description
`Folder`

getFolder(GetFolderRequest request)

public final Folder getFolder(GetFolderRequest request)

Fetches a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetFolderRequest request =
       GetFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .build();
   Folder response = dataformClient.getFolder(request);
 }

Parameter
Name	Description
`request`	`GetFolderRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Folder`

getFolder(String name)

public final Folder getFolder(String name)

Fetches a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString();
   Folder response = dataformClient.getFolder(name);
 }

Parameter
Name	Description
`name`	`String` Required. The Folder's name.

Returns
Type	Description
`Folder`

getFolderCallable()

public final UnaryCallable<GetFolderRequest,Folder> getFolderCallable()

Fetches a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetFolderRequest request =
       GetFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .build();
   ApiFuture<Folder> future = dataformClient.getFolderCallable().futureCall(request);
   // Do something.
   Folder response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetFolderRequest,Folder>`

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getIamPolicy(@Nullable ResourceName resource)

public final Policy getIamPolicy(@Nullable ResourceName resource)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ResourceName resource = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]");
   Policy response = dataformClient.getIamPolicy(resource);
 }

Parameter
Name	Description
`resource`	`@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceName` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = dataformClient.getIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicy(String resource)

public final Policy getIamPolicy(String resource)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String resource =
       CompilationResultName.of(
               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
           .toString();
   Policy response = dataformClient.getIamPolicy(resource);
 }

Parameter
Name	Description
`resource`	`String` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = dataformClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = dataformClient.getLocation(request);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = dataformClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type	Description
`OperationsClient`

getReleaseConfig(@Nullable ReleaseConfigName name)

public final ReleaseConfig getReleaseConfig(@Nullable ReleaseConfigName name)

Fetches a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ReleaseConfigName name =
       ReleaseConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]");
   ReleaseConfig response = dataformClient.getReleaseConfig(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.ReleaseConfigName` Required. The release config's name.

Returns
Type	Description
`ReleaseConfig`

getReleaseConfig(GetReleaseConfigRequest request)

public final ReleaseConfig getReleaseConfig(GetReleaseConfigRequest request)

Fetches a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetReleaseConfigRequest request =
       GetReleaseConfigRequest.newBuilder()
           .setName(
               ReleaseConfigName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]")
                   .toString())
           .build();
   ReleaseConfig response = dataformClient.getReleaseConfig(request);
 }

Parameter
Name	Description
`request`	`GetReleaseConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ReleaseConfig`

getReleaseConfig(String name)

public final ReleaseConfig getReleaseConfig(String name)

Fetches a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       ReleaseConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]")
           .toString();
   ReleaseConfig response = dataformClient.getReleaseConfig(name);
 }

Parameter
Name	Description
`name`	`String` Required. The release config's name.

Returns
Type	Description
`ReleaseConfig`

getReleaseConfigCallable()

public final UnaryCallable<GetReleaseConfigRequest,ReleaseConfig> getReleaseConfigCallable()

Fetches a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetReleaseConfigRequest request =
       GetReleaseConfigRequest.newBuilder()
           .setName(
               ReleaseConfigName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[RELEASE_CONFIG]")
                   .toString())
           .build();
   ApiFuture<ReleaseConfig> future =
       dataformClient.getReleaseConfigCallable().futureCall(request);
   // Do something.
   ReleaseConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetReleaseConfigRequest,ReleaseConfig>`

getRepository(@Nullable RepositoryName name)

public final Repository getRepository(@Nullable RepositoryName name)

Fetches a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   Repository response = dataformClient.getRepository(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository's name.

Returns
Type	Description
`Repository`

getRepository(GetRepositoryRequest request)

public final Repository getRepository(GetRepositoryRequest request)

Fetches a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetRepositoryRequest request =
       GetRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   Repository response = dataformClient.getRepository(request);
 }

Parameter
Name	Description
`request`	`GetRepositoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Repository`

getRepository(String name)

public final Repository getRepository(String name)

Fetches a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   Repository response = dataformClient.getRepository(name);
 }

Parameter
Name	Description
`name`	`String` Required. The repository's name.

Returns
Type	Description
`Repository`

getRepositoryCallable()

public final UnaryCallable<GetRepositoryRequest,Repository> getRepositoryCallable()

Fetches a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetRepositoryRequest request =
       GetRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   ApiFuture<Repository> future = dataformClient.getRepositoryCallable().futureCall(request);
   // Do something.
   Repository response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetRepositoryRequest,Repository>`

getSettings()

public final @Nullable DataformSettings getSettings()

Returns
Type	Description
`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.DataformSettings`

getStub()

public DataformStub getStub()

Returns
Type	Description
`DataformStub`

getTeamFolder(@Nullable TeamFolderName name)

public final TeamFolder getTeamFolder(@Nullable TeamFolderName name)

Fetches a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   TeamFolderName name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]");
   TeamFolder response = dataformClient.getTeamFolder(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.TeamFolderName` Required. The TeamFolder's name.

Returns
Type	Description
`TeamFolder`

getTeamFolder(GetTeamFolderRequest request)

public final TeamFolder getTeamFolder(GetTeamFolderRequest request)

Fetches a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetTeamFolderRequest request =
       GetTeamFolderRequest.newBuilder()
           .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .build();
   TeamFolder response = dataformClient.getTeamFolder(request);
 }

Parameter
Name	Description
`request`	`GetTeamFolderRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TeamFolder`

getTeamFolder(String name)

public final TeamFolder getTeamFolder(String name)

Fetches a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString();
   TeamFolder response = dataformClient.getTeamFolder(name);
 }

Parameter
Name	Description
`name`	`String` Required. The TeamFolder's name.

Returns
Type	Description
`TeamFolder`

getTeamFolderCallable()

public final UnaryCallable<GetTeamFolderRequest,TeamFolder> getTeamFolderCallable()

Fetches a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetTeamFolderRequest request =
       GetTeamFolderRequest.newBuilder()
           .setName(TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .build();
   ApiFuture<TeamFolder> future = dataformClient.getTeamFolderCallable().futureCall(request);
   // Do something.
   TeamFolder response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetTeamFolderRequest,TeamFolder>`

getWorkflowConfig(@Nullable WorkflowConfigName name)

public final WorkflowConfig getWorkflowConfig(@Nullable WorkflowConfigName name)

Fetches a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WorkflowConfigName name =
       WorkflowConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]");
   WorkflowConfig response = dataformClient.getWorkflowConfig(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.WorkflowConfigName` Required. The workflow config's name.

Returns
Type	Description
`WorkflowConfig`

getWorkflowConfig(GetWorkflowConfigRequest request)

public final WorkflowConfig getWorkflowConfig(GetWorkflowConfigRequest request)

Fetches a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetWorkflowConfigRequest request =
       GetWorkflowConfigRequest.newBuilder()
           .setName(
               WorkflowConfigName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]")
                   .toString())
           .build();
   WorkflowConfig response = dataformClient.getWorkflowConfig(request);
 }

Parameter
Name	Description
`request`	`GetWorkflowConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`WorkflowConfig`

getWorkflowConfig(String name)

public final WorkflowConfig getWorkflowConfig(String name)

Fetches a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       WorkflowConfigName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]")
           .toString();
   WorkflowConfig response = dataformClient.getWorkflowConfig(name);
 }

Parameter
Name	Description
`name`	`String` Required. The workflow config's name.

Returns
Type	Description
`WorkflowConfig`

getWorkflowConfigCallable()

public final UnaryCallable<GetWorkflowConfigRequest,WorkflowConfig> getWorkflowConfigCallable()

Fetches a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetWorkflowConfigRequest request =
       GetWorkflowConfigRequest.newBuilder()
           .setName(
               WorkflowConfigName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_CONFIG]")
                   .toString())
           .build();
   ApiFuture<WorkflowConfig> future =
       dataformClient.getWorkflowConfigCallable().futureCall(request);
   // Do something.
   WorkflowConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetWorkflowConfigRequest,WorkflowConfig>`

getWorkflowInvocation(@Nullable WorkflowInvocationName name)

public final WorkflowInvocation getWorkflowInvocation(@Nullable WorkflowInvocationName name)

Fetches a single WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WorkflowInvocationName name =
       WorkflowInvocationName.of(
           "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]");
   WorkflowInvocation response = dataformClient.getWorkflowInvocation(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.WorkflowInvocationName` Required. The workflow invocation resource's name.

Returns
Type	Description
`WorkflowInvocation`

getWorkflowInvocation(GetWorkflowInvocationRequest request)

public final WorkflowInvocation getWorkflowInvocation(GetWorkflowInvocationRequest request)

Fetches a single WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetWorkflowInvocationRequest request =
       GetWorkflowInvocationRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .build();
   WorkflowInvocation response = dataformClient.getWorkflowInvocation(request);
 }

Parameter
Name	Description
`request`	`GetWorkflowInvocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`WorkflowInvocation`

getWorkflowInvocation(String name)

public final WorkflowInvocation getWorkflowInvocation(String name)

Fetches a single WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       WorkflowInvocationName.of(
               "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
           .toString();
   WorkflowInvocation response = dataformClient.getWorkflowInvocation(name);
 }

Parameter
Name	Description
`name`	`String` Required. The workflow invocation resource's name.

Returns
Type	Description
`WorkflowInvocation`

getWorkflowInvocationCallable()

public final UnaryCallable<GetWorkflowInvocationRequest,WorkflowInvocation> getWorkflowInvocationCallable()

Fetches a single WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetWorkflowInvocationRequest request =
       GetWorkflowInvocationRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .build();
   ApiFuture<WorkflowInvocation> future =
       dataformClient.getWorkflowInvocationCallable().futureCall(request);
   // Do something.
   WorkflowInvocation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetWorkflowInvocationRequest,WorkflowInvocation>`

getWorkspace(@Nullable WorkspaceName name)

public final Workspace getWorkspace(@Nullable WorkspaceName name)

Fetches a single Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WorkspaceName name =
       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]");
   Workspace response = dataformClient.getWorkspace(name);
 }

Parameter
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.WorkspaceName` Required. The workspace's name.

Returns
Type	Description
`Workspace`

getWorkspace(GetWorkspaceRequest request)

public final Workspace getWorkspace(GetWorkspaceRequest request)

Fetches a single Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetWorkspaceRequest request =
       GetWorkspaceRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .build();
   Workspace response = dataformClient.getWorkspace(request);
 }

Parameter
Name	Description
`request`	`GetWorkspaceRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Workspace`

getWorkspace(String name)

public final Workspace getWorkspace(String name)

Fetches a single Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name =
       WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]").toString();
   Workspace response = dataformClient.getWorkspace(name);
 }

Parameter
Name	Description
`name`	`String` Required. The workspace's name.

Returns
Type	Description
`Workspace`

getWorkspaceCallable()

public final UnaryCallable<GetWorkspaceRequest,Workspace> getWorkspaceCallable()

Fetches a single Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   GetWorkspaceRequest request =
       GetWorkspaceRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .build();
   ApiFuture<Workspace> future = dataformClient.getWorkspaceCallable().futureCall(request);
   // Do something.
   Workspace response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetWorkspaceRequest,Workspace>`

installNpmPackages(InstallNpmPackagesRequest request)

public final InstallNpmPackagesResponse installNpmPackages(InstallNpmPackagesRequest request)

Installs dependency NPM packages (inside a Workspace).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   InstallNpmPackagesRequest request =
       InstallNpmPackagesRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .build();
   InstallNpmPackagesResponse response = dataformClient.installNpmPackages(request);
 }

Parameter
Name	Description
`request`	`InstallNpmPackagesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`InstallNpmPackagesResponse`

installNpmPackagesCallable()

public final UnaryCallable<InstallNpmPackagesRequest,InstallNpmPackagesResponse> installNpmPackagesCallable()

Installs dependency NPM packages (inside a Workspace).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   InstallNpmPackagesRequest request =
       InstallNpmPackagesRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .build();
   ApiFuture<InstallNpmPackagesResponse> future =
       dataformClient.installNpmPackagesCallable().futureCall(request);
   // Do something.
   InstallNpmPackagesResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<InstallNpmPackagesRequest,InstallNpmPackagesResponse>`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listCompilationResults(@Nullable RepositoryName parent)

public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults(@Nullable RepositoryName parent)

Lists CompilationResults in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   for (CompilationResult element : dataformClient.listCompilationResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to list compilation results. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListCompilationResultsPagedResponse`

listCompilationResults(ListCompilationResultsRequest request)

public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults(ListCompilationResultsRequest request)

Lists CompilationResults in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListCompilationResultsRequest request =
       ListCompilationResultsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (CompilationResult element :
       dataformClient.listCompilationResults(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListCompilationResultsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.ListCompilationResultsPagedResponse`

listCompilationResults(String parent)

public final DataformClient.ListCompilationResultsPagedResponse listCompilationResults(String parent)

Lists CompilationResults in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   for (CompilationResult element : dataformClient.listCompilationResults(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The repository in which to list compilation results. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListCompilationResultsPagedResponse`

listCompilationResultsCallable()

public final UnaryCallable<ListCompilationResultsRequest,ListCompilationResultsResponse> listCompilationResultsCallable()

Lists CompilationResults in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListCompilationResultsRequest request =
       ListCompilationResultsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListCompilationResultsResponse response =
         dataformClient.listCompilationResultsCallable().call(request);
     for (CompilationResult element : response.getCompilationResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListCompilationResultsRequest,ListCompilationResultsResponse>`

listCompilationResultsPagedCallable()

public final UnaryCallable<ListCompilationResultsRequest,DataformClient.ListCompilationResultsPagedResponse> listCompilationResultsPagedCallable()

Lists CompilationResults in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListCompilationResultsRequest request =
       ListCompilationResultsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<CompilationResult> future =
       dataformClient.listCompilationResultsPagedCallable().futureCall(request);
   // Do something.
   for (CompilationResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListCompilationResultsRequest,ListCompilationResultsPagedResponse>`

listLocations(ListLocationsRequest request)

public final DataformClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If name is empty, the method lists thepublic locations available to all projects. * **Project-specificlocations**: If name follows the formatprojects/{project}, the method lists locations visible to thatspecific project. This includes public, private, or otherproject-specific locations enabled for the project.

For gRPC and client library implementations, the resource name ispassed as the name field. For direct service calls, the resourcename isincorporated into the request path based on the specific serviceimplementation and version.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : dataformClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = dataformClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,DataformClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = dataformClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

listReleaseConfigs(@Nullable RepositoryName parent)

public final DataformClient.ListReleaseConfigsPagedResponse listReleaseConfigs(@Nullable RepositoryName parent)

Lists ReleaseConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   for (ReleaseConfig element : dataformClient.listReleaseConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to list release configs. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListReleaseConfigsPagedResponse`

listReleaseConfigs(ListReleaseConfigsRequest request)

public final DataformClient.ListReleaseConfigsPagedResponse listReleaseConfigs(ListReleaseConfigsRequest request)

Lists ReleaseConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListReleaseConfigsRequest request =
       ListReleaseConfigsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ReleaseConfig element : dataformClient.listReleaseConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListReleaseConfigsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.ListReleaseConfigsPagedResponse`

listReleaseConfigs(String parent)

public final DataformClient.ListReleaseConfigsPagedResponse listReleaseConfigs(String parent)

Lists ReleaseConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   for (ReleaseConfig element : dataformClient.listReleaseConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The repository in which to list release configs. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListReleaseConfigsPagedResponse`

listReleaseConfigsCallable()

public final UnaryCallable<ListReleaseConfigsRequest,ListReleaseConfigsResponse> listReleaseConfigsCallable()

Lists ReleaseConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListReleaseConfigsRequest request =
       ListReleaseConfigsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListReleaseConfigsResponse response =
         dataformClient.listReleaseConfigsCallable().call(request);
     for (ReleaseConfig element : response.getReleaseConfigsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListReleaseConfigsRequest,ListReleaseConfigsResponse>`

listReleaseConfigsPagedCallable()

public final UnaryCallable<ListReleaseConfigsRequest,DataformClient.ListReleaseConfigsPagedResponse> listReleaseConfigsPagedCallable()

Lists ReleaseConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListReleaseConfigsRequest request =
       ListReleaseConfigsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ReleaseConfig> future =
       dataformClient.listReleaseConfigsPagedCallable().futureCall(request);
   // Do something.
   for (ReleaseConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListReleaseConfigsRequest,ListReleaseConfigsPagedResponse>`

listRepositories(@Nullable LocationName parent)

public final DataformClient.ListRepositoriesPagedResponse listRepositories(@Nullable LocationName parent)

Lists Repositories in a given project and location.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Repository element : dataformClient.listRepositories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.LocationName` Required. The location in which to list repositories. Must be in the format `projects//locations/`.

Returns
Type	Description
`DataformClient.ListRepositoriesPagedResponse`

listRepositories(ListRepositoriesRequest request)

public final DataformClient.ListRepositoriesPagedResponse listRepositories(ListRepositoriesRequest request)

Lists Repositories in a given project and location.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListRepositoriesRequest request =
       ListRepositoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (Repository element : dataformClient.listRepositories(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListRepositoriesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.ListRepositoriesPagedResponse`

listRepositories(String parent)

public final DataformClient.ListRepositoriesPagedResponse listRepositories(String parent)

Lists Repositories in a given project and location.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Repository element : dataformClient.listRepositories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The location in which to list repositories. Must be in the format `projects//locations/`.

Returns
Type	Description
`DataformClient.ListRepositoriesPagedResponse`

listRepositoriesCallable()

public final UnaryCallable<ListRepositoriesRequest,ListRepositoriesResponse> listRepositoriesCallable()

Lists Repositories in a given project and location.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListRepositoriesRequest request =
       ListRepositoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListRepositoriesResponse response = dataformClient.listRepositoriesCallable().call(request);
     for (Repository element : response.getRepositoriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListRepositoriesRequest,ListRepositoriesResponse>`

listRepositoriesPagedCallable()

public final UnaryCallable<ListRepositoriesRequest,DataformClient.ListRepositoriesPagedResponse> listRepositoriesPagedCallable()

Lists Repositories in a given project and location.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListRepositoriesRequest request =
       ListRepositoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Repository> future =
       dataformClient.listRepositoriesPagedCallable().futureCall(request);
   // Do something.
   for (Repository element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListRepositoriesRequest,ListRepositoriesPagedResponse>`

listWorkflowConfigs(@Nullable RepositoryName parent)

public final DataformClient.ListWorkflowConfigsPagedResponse listWorkflowConfigs(@Nullable RepositoryName parent)

Lists WorkflowConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   for (WorkflowConfig element : dataformClient.listWorkflowConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to list workflow configs. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListWorkflowConfigsPagedResponse`

listWorkflowConfigs(ListWorkflowConfigsRequest request)

public final DataformClient.ListWorkflowConfigsPagedResponse listWorkflowConfigs(ListWorkflowConfigsRequest request)

Lists WorkflowConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkflowConfigsRequest request =
       ListWorkflowConfigsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (WorkflowConfig element : dataformClient.listWorkflowConfigs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListWorkflowConfigsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.ListWorkflowConfigsPagedResponse`

listWorkflowConfigs(String parent)

public final DataformClient.ListWorkflowConfigsPagedResponse listWorkflowConfigs(String parent)

Lists WorkflowConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   for (WorkflowConfig element : dataformClient.listWorkflowConfigs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The repository in which to list workflow configs. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListWorkflowConfigsPagedResponse`

listWorkflowConfigsCallable()

public final UnaryCallable<ListWorkflowConfigsRequest,ListWorkflowConfigsResponse> listWorkflowConfigsCallable()

Lists WorkflowConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkflowConfigsRequest request =
       ListWorkflowConfigsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListWorkflowConfigsResponse response =
         dataformClient.listWorkflowConfigsCallable().call(request);
     for (WorkflowConfig element : response.getWorkflowConfigsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListWorkflowConfigsRequest,ListWorkflowConfigsResponse>`

listWorkflowConfigsPagedCallable()

public final UnaryCallable<ListWorkflowConfigsRequest,DataformClient.ListWorkflowConfigsPagedResponse> listWorkflowConfigsPagedCallable()

Lists WorkflowConfigs in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkflowConfigsRequest request =
       ListWorkflowConfigsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<WorkflowConfig> future =
       dataformClient.listWorkflowConfigsPagedCallable().futureCall(request);
   // Do something.
   for (WorkflowConfig element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListWorkflowConfigsRequest,ListWorkflowConfigsPagedResponse>`

listWorkflowInvocations(@Nullable RepositoryName parent)

public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations(@Nullable RepositoryName parent)

Lists WorkflowInvocations in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   for (WorkflowInvocation element :
       dataformClient.listWorkflowInvocations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListWorkflowInvocationsPagedResponse`

listWorkflowInvocations(ListWorkflowInvocationsRequest request)

public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations(ListWorkflowInvocationsRequest request)

Lists WorkflowInvocations in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkflowInvocationsRequest request =
       ListWorkflowInvocationsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (WorkflowInvocation element :
       dataformClient.listWorkflowInvocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListWorkflowInvocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.ListWorkflowInvocationsPagedResponse`

listWorkflowInvocations(String parent)

public final DataformClient.ListWorkflowInvocationsPagedResponse listWorkflowInvocations(String parent)

Lists WorkflowInvocations in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   for (WorkflowInvocation element :
       dataformClient.listWorkflowInvocations(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListWorkflowInvocationsPagedResponse`

listWorkflowInvocationsCallable()

public final UnaryCallable<ListWorkflowInvocationsRequest,ListWorkflowInvocationsResponse> listWorkflowInvocationsCallable()

Lists WorkflowInvocations in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkflowInvocationsRequest request =
       ListWorkflowInvocationsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListWorkflowInvocationsResponse response =
         dataformClient.listWorkflowInvocationsCallable().call(request);
     for (WorkflowInvocation element : response.getWorkflowInvocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListWorkflowInvocationsRequest,ListWorkflowInvocationsResponse>`

listWorkflowInvocationsPagedCallable()

public final UnaryCallable<ListWorkflowInvocationsRequest,DataformClient.ListWorkflowInvocationsPagedResponse> listWorkflowInvocationsPagedCallable()

Lists WorkflowInvocations in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkflowInvocationsRequest request =
       ListWorkflowInvocationsRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<WorkflowInvocation> future =
       dataformClient.listWorkflowInvocationsPagedCallable().futureCall(request);
   // Do something.
   for (WorkflowInvocation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListWorkflowInvocationsRequest,ListWorkflowInvocationsPagedResponse>`

listWorkspaces(@Nullable RepositoryName parent)

public final DataformClient.ListWorkspacesPagedResponse listWorkspaces(@Nullable RepositoryName parent)

Lists Workspaces in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   for (Workspace element : dataformClient.listWorkspaces(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The repository in which to list workspaces. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListWorkspacesPagedResponse`

listWorkspaces(ListWorkspacesRequest request)

public final DataformClient.ListWorkspacesPagedResponse listWorkspaces(ListWorkspacesRequest request)

Lists Workspaces in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkspacesRequest request =
       ListWorkspacesRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (Workspace element : dataformClient.listWorkspaces(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListWorkspacesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.ListWorkspacesPagedResponse`

listWorkspaces(String parent)

public final DataformClient.ListWorkspacesPagedResponse listWorkspaces(String parent)

Lists Workspaces in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String parent = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   for (Workspace element : dataformClient.listWorkspaces(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The repository in which to list workspaces. Must be in the format `projects//locations//repositories/*`.

Returns
Type	Description
`DataformClient.ListWorkspacesPagedResponse`

listWorkspacesCallable()

public final UnaryCallable<ListWorkspacesRequest,ListWorkspacesResponse> listWorkspacesCallable()

Lists Workspaces in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkspacesRequest request =
       ListWorkspacesRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     ListWorkspacesResponse response = dataformClient.listWorkspacesCallable().call(request);
     for (Workspace element : response.getWorkspacesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListWorkspacesRequest,ListWorkspacesResponse>`

listWorkspacesPagedCallable()

public final UnaryCallable<ListWorkspacesRequest,DataformClient.ListWorkspacesPagedResponse> listWorkspacesPagedCallable()

Lists Workspaces in a given Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ListWorkspacesRequest request =
       ListWorkspacesRequest.newBuilder()
           .setParent(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<Workspace> future =
       dataformClient.listWorkspacesPagedCallable().futureCall(request);
   // Do something.
   for (Workspace element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListWorkspacesRequest,ListWorkspacesPagedResponse>`

makeDirectory(MakeDirectoryRequest request)

public final MakeDirectoryResponse makeDirectory(MakeDirectoryRequest request)

Creates a directory inside a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MakeDirectoryRequest request =
       MakeDirectoryRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .build();
   MakeDirectoryResponse response = dataformClient.makeDirectory(request);
 }

Parameter
Name	Description
`request`	`MakeDirectoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`MakeDirectoryResponse`

makeDirectoryCallable()

public final UnaryCallable<MakeDirectoryRequest,MakeDirectoryResponse> makeDirectoryCallable()

Creates a directory inside a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MakeDirectoryRequest request =
       MakeDirectoryRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .build();
   ApiFuture<MakeDirectoryResponse> future =
       dataformClient.makeDirectoryCallable().futureCall(request);
   // Do something.
   MakeDirectoryResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<MakeDirectoryRequest,MakeDirectoryResponse>`

moveDirectory(MoveDirectoryRequest request)

public final MoveDirectoryResponse moveDirectory(MoveDirectoryRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveDirectoryRequest request =
       MoveDirectoryRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setNewPath("newPath1845080549")
           .build();
   MoveDirectoryResponse response = dataformClient.moveDirectory(request);
 }

Parameter
Name	Description
`request`	`MoveDirectoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`MoveDirectoryResponse`

moveDirectoryCallable()

public final UnaryCallable<MoveDirectoryRequest,MoveDirectoryResponse> moveDirectoryCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveDirectoryRequest request =
       MoveDirectoryRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setNewPath("newPath1845080549")
           .build();
   ApiFuture<MoveDirectoryResponse> future =
       dataformClient.moveDirectoryCallable().futureCall(request);
   // Do something.
   MoveDirectoryResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<MoveDirectoryRequest,MoveDirectoryResponse>`

moveFile(MoveFileRequest request)

public final MoveFileResponse moveFile(MoveFileRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveFileRequest request =
       MoveFileRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setNewPath("newPath1845080549")
           .build();
   MoveFileResponse response = dataformClient.moveFile(request);
 }

Parameter
Name	Description
`request`	`MoveFileRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`MoveFileResponse`

moveFileCallable()

public final UnaryCallable<MoveFileRequest,MoveFileResponse> moveFileCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveFileRequest request =
       MoveFileRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setNewPath("newPath1845080549")
           .build();
   ApiFuture<MoveFileResponse> future = dataformClient.moveFileCallable().futureCall(request);
   // Do something.
   MoveFileResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<MoveFileRequest,MoveFileResponse>`

moveFolderAsync(@Nullable FolderName name, String destinationContainingFolder)

public final OperationFuture<Empty,MoveFolderMetadata> moveFolderAsync(@Nullable FolderName name, String destinationContainingFolder)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FolderName name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]");
   String destinationContainingFolder = "destinationContainingFolder870737098";
   dataformClient.moveFolderAsync(name, destinationContainingFolder).get();
 }

Parameters
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.FolderName` Required. The full resource name of the Folder to move.
`destinationContainingFolder`	`String` Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, `projects//locations//folders/`, `projects//locations//teamFolders/`

Returns
Type	Description
`OperationFuture<Empty,MoveFolderMetadata>`

moveFolderAsync(MoveFolderRequest request)

public final OperationFuture<Empty,MoveFolderMetadata> moveFolderAsync(MoveFolderRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveFolderRequest request =
       MoveFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setDestinationContainingFolder("destinationContainingFolder870737098")
           .build();
   dataformClient.moveFolderAsync(request).get();
 }

Parameter
Name	Description
`request`	`MoveFolderRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,MoveFolderMetadata>`

moveFolderAsync(String name, String destinationContainingFolder)

public final OperationFuture<Empty,MoveFolderMetadata> moveFolderAsync(String name, String destinationContainingFolder)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString();
   String destinationContainingFolder = "destinationContainingFolder870737098";
   dataformClient.moveFolderAsync(name, destinationContainingFolder).get();
 }

Parameters
Name	Description
`name`	`String` Required. The full resource name of the Folder to move.
`destinationContainingFolder`	`String` Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, `projects//locations//folders/`, `projects//locations//teamFolders/`

Returns
Type	Description
`OperationFuture<Empty,MoveFolderMetadata>`

moveFolderCallable()

public final UnaryCallable<MoveFolderRequest,Operation> moveFolderCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveFolderRequest request =
       MoveFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setDestinationContainingFolder("destinationContainingFolder870737098")
           .build();
   ApiFuture<Operation> future = dataformClient.moveFolderCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<MoveFolderRequest,Operation>`

moveFolderOperationCallable()

public final OperationCallable<MoveFolderRequest,Empty,MoveFolderMetadata> moveFolderOperationCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveFolderRequest request =
       MoveFolderRequest.newBuilder()
           .setName(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setDestinationContainingFolder("destinationContainingFolder870737098")
           .build();
   OperationFuture<Empty, MoveFolderMetadata> future =
       dataformClient.moveFolderOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<MoveFolderRequest,Empty,MoveFolderMetadata>`

moveRepositoryAsync(@Nullable RepositoryName name, String destinationContainingFolder)

public final OperationFuture<Empty,MoveRepositoryMetadata> moveRepositoryAsync(@Nullable RepositoryName name, String destinationContainingFolder)

Moves a Repository to a new location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   String destinationContainingFolder = "destinationContainingFolder870737098";
   dataformClient.moveRepositoryAsync(name, destinationContainingFolder).get();
 }

Parameters
Name	Description
`name`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.RepositoryName` Required. The full resource name of the repository to move.
`destinationContainingFolder`	`String` Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, `projects//locations//folders/`, `projects//locations//teamFolders/`

Returns
Type	Description
`OperationFuture<Empty,MoveRepositoryMetadata>`

moveRepositoryAsync(MoveRepositoryRequest request)

public final OperationFuture<Empty,MoveRepositoryMetadata> moveRepositoryAsync(MoveRepositoryRequest request)

Moves a Repository to a new location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveRepositoryRequest request =
       MoveRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setDestinationContainingFolder("destinationContainingFolder870737098")
           .build();
   dataformClient.moveRepositoryAsync(request).get();
 }

Parameter
Name	Description
`request`	`MoveRepositoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<Empty,MoveRepositoryMetadata>`

moveRepositoryAsync(String name, String destinationContainingFolder)

public final OperationFuture<Empty,MoveRepositoryMetadata> moveRepositoryAsync(String name, String destinationContainingFolder)

Moves a Repository to a new location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   String destinationContainingFolder = "destinationContainingFolder870737098";
   dataformClient.moveRepositoryAsync(name, destinationContainingFolder).get();
 }

Parameters
Name	Description
`name`	`String` Required. The full resource name of the repository to move.
`destinationContainingFolder`	`String` Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, `projects//locations//folders/`, `projects//locations//teamFolders/`

Returns
Type	Description
`OperationFuture<Empty,MoveRepositoryMetadata>`

moveRepositoryCallable()

public final UnaryCallable<MoveRepositoryRequest,Operation> moveRepositoryCallable()

Moves a Repository to a new location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveRepositoryRequest request =
       MoveRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setDestinationContainingFolder("destinationContainingFolder870737098")
           .build();
   ApiFuture<Operation> future = dataformClient.moveRepositoryCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<MoveRepositoryRequest,Operation>`

moveRepositoryOperationCallable()

public final OperationCallable<MoveRepositoryRequest,Empty,MoveRepositoryMetadata> moveRepositoryOperationCallable()

Moves a Repository to a new location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   MoveRepositoryRequest request =
       MoveRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setDestinationContainingFolder("destinationContainingFolder870737098")
           .build();
   OperationFuture<Empty, MoveRepositoryMetadata> future =
       dataformClient.moveRepositoryOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`OperationCallable<MoveRepositoryRequest,Empty,MoveRepositoryMetadata>`

pullGitCommits(PullGitCommitsRequest request)

public final PullGitCommitsResponse pullGitCommits(PullGitCommitsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   PullGitCommitsRequest request =
       PullGitCommitsRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setRemoteBranch("remoteBranch-533119608")
           .setAuthor(CommitAuthor.newBuilder().build())
           .build();
   PullGitCommitsResponse response = dataformClient.pullGitCommits(request);
 }

Parameter
Name	Description
`request`	`PullGitCommitsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`PullGitCommitsResponse`

pullGitCommitsCallable()

public final UnaryCallable<PullGitCommitsRequest,PullGitCommitsResponse> pullGitCommitsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   PullGitCommitsRequest request =
       PullGitCommitsRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setRemoteBranch("remoteBranch-533119608")
           .setAuthor(CommitAuthor.newBuilder().build())
           .build();
   ApiFuture<PullGitCommitsResponse> future =
       dataformClient.pullGitCommitsCallable().futureCall(request);
   // Do something.
   PullGitCommitsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<PullGitCommitsRequest,PullGitCommitsResponse>`

pushGitCommits(PushGitCommitsRequest request)

public final PushGitCommitsResponse pushGitCommits(PushGitCommitsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   PushGitCommitsRequest request =
       PushGitCommitsRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setRemoteBranch("remoteBranch-533119608")
           .build();
   PushGitCommitsResponse response = dataformClient.pushGitCommits(request);
 }

Parameter
Name	Description
`request`	`PushGitCommitsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`PushGitCommitsResponse`

pushGitCommitsCallable()

public final UnaryCallable<PushGitCommitsRequest,PushGitCommitsResponse> pushGitCommitsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   PushGitCommitsRequest request =
       PushGitCommitsRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setRemoteBranch("remoteBranch-533119608")
           .build();
   ApiFuture<PushGitCommitsResponse> future =
       dataformClient.pushGitCommitsCallable().futureCall(request);
   // Do something.
   PushGitCommitsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<PushGitCommitsRequest,PushGitCommitsResponse>`

queryCompilationResultActions(QueryCompilationResultActionsRequest request)

public final DataformClient.QueryCompilationResultActionsPagedResponse queryCompilationResultActions(QueryCompilationResultActionsRequest request)

Returns CompilationResultActions in a given CompilationResult.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryCompilationResultActionsRequest request =
       QueryCompilationResultActionsRequest.newBuilder()
           .setName(
               CompilationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (CompilationResultAction element :
       dataformClient.queryCompilationResultActions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`QueryCompilationResultActionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.QueryCompilationResultActionsPagedResponse`

queryCompilationResultActionsCallable()

public final UnaryCallable<QueryCompilationResultActionsRequest,QueryCompilationResultActionsResponse> queryCompilationResultActionsCallable()

Returns CompilationResultActions in a given CompilationResult.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryCompilationResultActionsRequest request =
       QueryCompilationResultActionsRequest.newBuilder()
           .setName(
               CompilationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     QueryCompilationResultActionsResponse response =
         dataformClient.queryCompilationResultActionsCallable().call(request);
     for (CompilationResultAction element : response.getCompilationResultActionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<QueryCompilationResultActionsRequest,QueryCompilationResultActionsResponse>`

queryCompilationResultActionsPagedCallable()

public final UnaryCallable<QueryCompilationResultActionsRequest,DataformClient.QueryCompilationResultActionsPagedResponse> queryCompilationResultActionsPagedCallable()

Returns CompilationResultActions in a given CompilationResult.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryCompilationResultActionsRequest request =
       QueryCompilationResultActionsRequest.newBuilder()
           .setName(
               CompilationResultName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[COMPILATION_RESULT]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<CompilationResultAction> future =
       dataformClient.queryCompilationResultActionsPagedCallable().futureCall(request);
   // Do something.
   for (CompilationResultAction element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<QueryCompilationResultActionsRequest,QueryCompilationResultActionsPagedResponse>`

queryDirectoryContents(QueryDirectoryContentsRequest request)

public final DataformClient.QueryDirectoryContentsPagedResponse queryDirectoryContents(QueryDirectoryContentsRequest request)

Returns the contents of a given Workspace directory.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryDirectoryContentsRequest request =
       QueryDirectoryContentsRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(DirectoryContentsView.forNumber(0))
           .build();
   for (DirectoryEntry element : dataformClient.queryDirectoryContents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`QueryDirectoryContentsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.QueryDirectoryContentsPagedResponse`

queryDirectoryContentsCallable()

public final UnaryCallable<QueryDirectoryContentsRequest,QueryDirectoryContentsResponse> queryDirectoryContentsCallable()

Returns the contents of a given Workspace directory.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryDirectoryContentsRequest request =
       QueryDirectoryContentsRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(DirectoryContentsView.forNumber(0))
           .build();
   while (true) {
     QueryDirectoryContentsResponse response =
         dataformClient.queryDirectoryContentsCallable().call(request);
     for (DirectoryEntry element : response.getDirectoryEntriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<QueryDirectoryContentsRequest,QueryDirectoryContentsResponse>`

queryDirectoryContentsPagedCallable()

public final UnaryCallable<QueryDirectoryContentsRequest,DataformClient.QueryDirectoryContentsPagedResponse> queryDirectoryContentsPagedCallable()

Returns the contents of a given Workspace directory.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryDirectoryContentsRequest request =
       QueryDirectoryContentsRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(DirectoryContentsView.forNumber(0))
           .build();
   ApiFuture<DirectoryEntry> future =
       dataformClient.queryDirectoryContentsPagedCallable().futureCall(request);
   // Do something.
   for (DirectoryEntry element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<QueryDirectoryContentsRequest,QueryDirectoryContentsPagedResponse>`

queryFolderContents(@Nullable FolderName folder)

public final DataformClient.QueryFolderContentsPagedResponse queryFolderContents(@Nullable FolderName folder)

Returns the contents of a given Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   FolderName folder = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]");
   for (QueryFolderContentsResponse.FolderContentsEntry element :
       dataformClient.queryFolderContents(folder).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`folder`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.FolderName` Required. Resource name of the Folder to list contents for. Format: projects//locations//folders/*

Returns
Type	Description
`DataformClient.QueryFolderContentsPagedResponse`

queryFolderContents(QueryFolderContentsRequest request)

public final DataformClient.QueryFolderContentsPagedResponse queryFolderContents(QueryFolderContentsRequest request)

Returns the contents of a given Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryFolderContentsRequest request =
       QueryFolderContentsRequest.newBuilder()
           .setFolder(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (QueryFolderContentsResponse.FolderContentsEntry element :
       dataformClient.queryFolderContents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`QueryFolderContentsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.QueryFolderContentsPagedResponse`

queryFolderContents(String folder)

public final DataformClient.QueryFolderContentsPagedResponse queryFolderContents(String folder)

Returns the contents of a given Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String folder = FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString();
   for (QueryFolderContentsResponse.FolderContentsEntry element :
       dataformClient.queryFolderContents(folder).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`folder`	`String` Required. Resource name of the Folder to list contents for. Format: projects//locations//folders/*

Returns
Type	Description
`DataformClient.QueryFolderContentsPagedResponse`

queryFolderContentsCallable()

public final UnaryCallable<QueryFolderContentsRequest,QueryFolderContentsResponse> queryFolderContentsCallable()

Returns the contents of a given Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryFolderContentsRequest request =
       QueryFolderContentsRequest.newBuilder()
           .setFolder(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     QueryFolderContentsResponse response =
         dataformClient.queryFolderContentsCallable().call(request);
     for (QueryFolderContentsResponse.FolderContentsEntry element : response.getEntriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<QueryFolderContentsRequest,QueryFolderContentsResponse>`

queryFolderContentsPagedCallable()

public final UnaryCallable<QueryFolderContentsRequest,DataformClient.QueryFolderContentsPagedResponse> queryFolderContentsPagedCallable()

Returns the contents of a given Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryFolderContentsRequest request =
       QueryFolderContentsRequest.newBuilder()
           .setFolder(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<QueryFolderContentsResponse.FolderContentsEntry> future =
       dataformClient.queryFolderContentsPagedCallable().futureCall(request);
   // Do something.
   for (QueryFolderContentsResponse.FolderContentsEntry element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<QueryFolderContentsRequest,QueryFolderContentsPagedResponse>`

queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request)

public final DataformClient.QueryRepositoryDirectoryContentsPagedResponse queryRepositoryDirectoryContents(QueryRepositoryDirectoryContentsRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryRepositoryDirectoryContentsRequest request =
       QueryRepositoryDirectoryContentsRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCommitSha("commitSha-1491174411")
           .setPath("path3433509")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DirectoryEntry element :
       dataformClient.queryRepositoryDirectoryContents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`QueryRepositoryDirectoryContentsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.QueryRepositoryDirectoryContentsPagedResponse`

queryRepositoryDirectoryContentsCallable()

public final UnaryCallable<QueryRepositoryDirectoryContentsRequest,QueryRepositoryDirectoryContentsResponse> queryRepositoryDirectoryContentsCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryRepositoryDirectoryContentsRequest request =
       QueryRepositoryDirectoryContentsRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCommitSha("commitSha-1491174411")
           .setPath("path3433509")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     QueryRepositoryDirectoryContentsResponse response =
         dataformClient.queryRepositoryDirectoryContentsCallable().call(request);
     for (DirectoryEntry element : response.getDirectoryEntriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<QueryRepositoryDirectoryContentsRequest,QueryRepositoryDirectoryContentsResponse>`

queryRepositoryDirectoryContentsPagedCallable()

public final UnaryCallable<QueryRepositoryDirectoryContentsRequest,DataformClient.QueryRepositoryDirectoryContentsPagedResponse> queryRepositoryDirectoryContentsPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryRepositoryDirectoryContentsRequest request =
       QueryRepositoryDirectoryContentsRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCommitSha("commitSha-1491174411")
           .setPath("path3433509")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DirectoryEntry> future =
       dataformClient.queryRepositoryDirectoryContentsPagedCallable().futureCall(request);
   // Do something.
   for (DirectoryEntry element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<QueryRepositoryDirectoryContentsRequest,QueryRepositoryDirectoryContentsPagedResponse>`

queryTeamFolderContents(@Nullable TeamFolderName teamFolder)

public final DataformClient.QueryTeamFolderContentsPagedResponse queryTeamFolderContents(@Nullable TeamFolderName teamFolder)

Returns the contents of a given TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   TeamFolderName teamFolder = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]");
   for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element :
       dataformClient.queryTeamFolderContents(teamFolder).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`teamFolder`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.TeamFolderName` Required. Resource name of the TeamFolder to list contents for. Format: `projects//locations//teamFolders/*`.

Returns
Type	Description
`DataformClient.QueryTeamFolderContentsPagedResponse`

queryTeamFolderContents(QueryTeamFolderContentsRequest request)

public final DataformClient.QueryTeamFolderContentsPagedResponse queryTeamFolderContents(QueryTeamFolderContentsRequest request)

Returns the contents of a given TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryTeamFolderContentsRequest request =
       QueryTeamFolderContentsRequest.newBuilder()
           .setTeamFolder(
               TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element :
       dataformClient.queryTeamFolderContents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`QueryTeamFolderContentsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.QueryTeamFolderContentsPagedResponse`

queryTeamFolderContents(String teamFolder)

public final DataformClient.QueryTeamFolderContentsPagedResponse queryTeamFolderContents(String teamFolder)

Returns the contents of a given TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String teamFolder = TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString();
   for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element :
       dataformClient.queryTeamFolderContents(teamFolder).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`teamFolder`	`String` Required. Resource name of the TeamFolder to list contents for. Format: `projects//locations//teamFolders/*`.

Returns
Type	Description
`DataformClient.QueryTeamFolderContentsPagedResponse`

queryTeamFolderContentsCallable()

public final UnaryCallable<QueryTeamFolderContentsRequest,QueryTeamFolderContentsResponse> queryTeamFolderContentsCallable()

Returns the contents of a given TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryTeamFolderContentsRequest request =
       QueryTeamFolderContentsRequest.newBuilder()
           .setTeamFolder(
               TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     QueryTeamFolderContentsResponse response =
         dataformClient.queryTeamFolderContentsCallable().call(request);
     for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element :
         response.getEntriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<QueryTeamFolderContentsRequest,QueryTeamFolderContentsResponse>`

queryTeamFolderContentsPagedCallable()

public final UnaryCallable<QueryTeamFolderContentsRequest,DataformClient.QueryTeamFolderContentsPagedResponse> queryTeamFolderContentsPagedCallable()

Returns the contents of a given TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryTeamFolderContentsRequest request =
       QueryTeamFolderContentsRequest.newBuilder()
           .setTeamFolder(
               TeamFolderName.of("[PROJECT]", "[LOCATION]", "[TEAM_FOLDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<QueryTeamFolderContentsResponse.TeamFolderContentsEntry> future =
       dataformClient.queryTeamFolderContentsPagedCallable().futureCall(request);
   // Do something.
   for (QueryTeamFolderContentsResponse.TeamFolderContentsEntry element :
       future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<QueryTeamFolderContentsRequest,QueryTeamFolderContentsPagedResponse>`

queryUserRootContents(@Nullable LocationName location)

public final DataformClient.QueryUserRootContentsPagedResponse queryUserRootContents(@Nullable LocationName location)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
   for (QueryUserRootContentsResponse.RootContentsEntry element :
       dataformClient.queryUserRootContents(location).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`location`	`@org.jspecify.annotations.Nullable com.google.cloud.dataform.v1.LocationName` Required. Location of the user root folder to list contents for. Format: projects//locations/

Returns
Type	Description
`DataformClient.QueryUserRootContentsPagedResponse`

queryUserRootContents(QueryUserRootContentsRequest request)

public final DataformClient.QueryUserRootContentsPagedResponse queryUserRootContents(QueryUserRootContentsRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryUserRootContentsRequest request =
       QueryUserRootContentsRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (QueryUserRootContentsResponse.RootContentsEntry element :
       dataformClient.queryUserRootContents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`QueryUserRootContentsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.QueryUserRootContentsPagedResponse`

queryUserRootContents(String location)

public final DataformClient.QueryUserRootContentsPagedResponse queryUserRootContents(String location)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (QueryUserRootContentsResponse.RootContentsEntry element :
       dataformClient.queryUserRootContents(location).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`location`	`String` Required. Location of the user root folder to list contents for. Format: projects//locations/

Returns
Type	Description
`DataformClient.QueryUserRootContentsPagedResponse`

queryUserRootContentsCallable()

public final UnaryCallable<QueryUserRootContentsRequest,QueryUserRootContentsResponse> queryUserRootContentsCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryUserRootContentsRequest request =
       QueryUserRootContentsRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     QueryUserRootContentsResponse response =
         dataformClient.queryUserRootContentsCallable().call(request);
     for (QueryUserRootContentsResponse.RootContentsEntry element : response.getEntriesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<QueryUserRootContentsRequest,QueryUserRootContentsResponse>`

queryUserRootContentsPagedCallable()

public final UnaryCallable<QueryUserRootContentsRequest,DataformClient.QueryUserRootContentsPagedResponse> queryUserRootContentsPagedCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryUserRootContentsRequest request =
       QueryUserRootContentsRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<QueryUserRootContentsResponse.RootContentsEntry> future =
       dataformClient.queryUserRootContentsPagedCallable().futureCall(request);
   // Do something.
   for (QueryUserRootContentsResponse.RootContentsEntry element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<QueryUserRootContentsRequest,QueryUserRootContentsPagedResponse>`

queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request)

public final DataformClient.QueryWorkflowInvocationActionsPagedResponse queryWorkflowInvocationActions(QueryWorkflowInvocationActionsRequest request)

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryWorkflowInvocationActionsRequest request =
       QueryWorkflowInvocationActionsRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (WorkflowInvocationAction element :
       dataformClient.queryWorkflowInvocationActions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`QueryWorkflowInvocationActionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.QueryWorkflowInvocationActionsPagedResponse`

queryWorkflowInvocationActionsCallable()

public final UnaryCallable<QueryWorkflowInvocationActionsRequest,QueryWorkflowInvocationActionsResponse> queryWorkflowInvocationActionsCallable()

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryWorkflowInvocationActionsRequest request =
       QueryWorkflowInvocationActionsRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     QueryWorkflowInvocationActionsResponse response =
         dataformClient.queryWorkflowInvocationActionsCallable().call(request);
     for (WorkflowInvocationAction element : response.getWorkflowInvocationActionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<QueryWorkflowInvocationActionsRequest,QueryWorkflowInvocationActionsResponse>`

queryWorkflowInvocationActionsPagedCallable()

public final UnaryCallable<QueryWorkflowInvocationActionsRequest,DataformClient.QueryWorkflowInvocationActionsPagedResponse> queryWorkflowInvocationActionsPagedCallable()

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   QueryWorkflowInvocationActionsRequest request =
       QueryWorkflowInvocationActionsRequest.newBuilder()
           .setName(
               WorkflowInvocationName.of(
                       "[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKFLOW_INVOCATION]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<WorkflowInvocationAction> future =
       dataformClient.queryWorkflowInvocationActionsPagedCallable().futureCall(request);
   // Do something.
   for (WorkflowInvocationAction element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<QueryWorkflowInvocationActionsRequest,QueryWorkflowInvocationActionsPagedResponse>`

readFile(ReadFileRequest request)

public final ReadFileResponse readFile(ReadFileRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ReadFileRequest request =
       ReadFileRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setRevision("revision-260786213")
           .build();
   ReadFileResponse response = dataformClient.readFile(request);
 }

Parameter
Name	Description
`request`	`ReadFileRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ReadFileResponse`

readFileCallable()

public final UnaryCallable<ReadFileRequest,ReadFileResponse> readFileCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ReadFileRequest request =
       ReadFileRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setRevision("revision-260786213")
           .build();
   ApiFuture<ReadFileResponse> future = dataformClient.readFileCallable().futureCall(request);
   // Do something.
   ReadFileResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ReadFileRequest,ReadFileResponse>`

readRepositoryFile(ReadRepositoryFileRequest request)

public final 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ReadRepositoryFileRequest request =
       ReadRepositoryFileRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCommitSha("commitSha-1491174411")
           .setPath("path3433509")
           .build();
   ReadRepositoryFileResponse response = dataformClient.readRepositoryFile(request);
 }

Parameter
Name	Description
`request`	`ReadRepositoryFileRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ReadRepositoryFileResponse`

readRepositoryFileCallable()

public final UnaryCallable<ReadRepositoryFileRequest,ReadRepositoryFileResponse> readRepositoryFileCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ReadRepositoryFileRequest request =
       ReadRepositoryFileRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .setCommitSha("commitSha-1491174411")
           .setPath("path3433509")
           .build();
   ApiFuture<ReadRepositoryFileResponse> future =
       dataformClient.readRepositoryFileCallable().futureCall(request);
   // Do something.
   ReadRepositoryFileResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ReadRepositoryFileRequest,ReadRepositoryFileResponse>`

removeDirectory(RemoveDirectoryRequest request)

public final RemoveDirectoryResponse removeDirectory(RemoveDirectoryRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RemoveDirectoryRequest request =
       RemoveDirectoryRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .build();
   RemoveDirectoryResponse response = dataformClient.removeDirectory(request);
 }

Parameter
Name	Description
`request`	`RemoveDirectoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RemoveDirectoryResponse`

removeDirectoryCallable()

public final UnaryCallable<RemoveDirectoryRequest,RemoveDirectoryResponse> removeDirectoryCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RemoveDirectoryRequest request =
       RemoveDirectoryRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .build();
   ApiFuture<RemoveDirectoryResponse> future =
       dataformClient.removeDirectoryCallable().futureCall(request);
   // Do something.
   RemoveDirectoryResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RemoveDirectoryRequest,RemoveDirectoryResponse>`

removeFile(RemoveFileRequest request)

public final RemoveFileResponse removeFile(RemoveFileRequest request)

Deletes a file (inside a Workspace).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RemoveFileRequest request =
       RemoveFileRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .build();
   RemoveFileResponse response = dataformClient.removeFile(request);
 }

Parameter
Name	Description
`request`	`RemoveFileRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RemoveFileResponse`

removeFileCallable()

public final UnaryCallable<RemoveFileRequest,RemoveFileResponse> removeFileCallable()

Deletes a file (inside a Workspace).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   RemoveFileRequest request =
       RemoveFileRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .build();
   ApiFuture<RemoveFileResponse> future =
       dataformClient.removeFileCallable().futureCall(request);
   // Do something.
   RemoveFileResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RemoveFileRequest,RemoveFileResponse>`

resetWorkspaceChanges(ResetWorkspaceChangesRequest request)

public final ResetWorkspaceChangesResponse resetWorkspaceChanges(ResetWorkspaceChangesRequest request)

Performs a Git reset for uncommitted files in a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ResetWorkspaceChangesRequest request =
       ResetWorkspaceChangesRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .addAllPaths(new ArrayList<String>())
           .setClean(true)
           .build();
   ResetWorkspaceChangesResponse response = dataformClient.resetWorkspaceChanges(request);
 }

Parameter
Name	Description
`request`	`ResetWorkspaceChangesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ResetWorkspaceChangesResponse`

resetWorkspaceChangesCallable()

public final UnaryCallable<ResetWorkspaceChangesRequest,ResetWorkspaceChangesResponse> resetWorkspaceChangesCallable()

Performs a Git reset for uncommitted files in a Workspace.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ResetWorkspaceChangesRequest request =
       ResetWorkspaceChangesRequest.newBuilder()
           .setName(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .addAllPaths(new ArrayList<String>())
           .setClean(true)
           .build();
   ApiFuture<ResetWorkspaceChangesResponse> future =
       dataformClient.resetWorkspaceChangesCallable().futureCall(request);
   // Do something.
   ResetWorkspaceChangesResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ResetWorkspaceChangesRequest,ResetWorkspaceChangesResponse>`

searchFiles(SearchFilesRequest request)

public final DataformClient.SearchFilesPagedResponse searchFiles(SearchFilesRequest request)

Finds the contents of a given Workspace directory by filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   SearchFilesRequest request =
       SearchFilesRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   for (SearchResult element : dataformClient.searchFiles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`SearchFilesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.SearchFilesPagedResponse`

searchFilesCallable()

public final UnaryCallable<SearchFilesRequest,SearchFilesResponse> searchFilesCallable()

Finds the contents of a given Workspace directory by filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   SearchFilesRequest request =
       SearchFilesRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     SearchFilesResponse response = dataformClient.searchFilesCallable().call(request);
     for (SearchResult element : response.getSearchResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<SearchFilesRequest,SearchFilesResponse>`

searchFilesPagedCallable()

public final UnaryCallable<SearchFilesRequest,DataformClient.SearchFilesPagedResponse> searchFilesPagedCallable()

Finds the contents of a given Workspace directory by filter.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   SearchFilesRequest request =
       SearchFilesRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<SearchResult> future =
       dataformClient.searchFilesPagedCallable().futureCall(request);
   // Do something.
   for (SearchResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<SearchFilesRequest,SearchFilesPagedResponse>`

searchTeamFolders(SearchTeamFoldersRequest request)

public final DataformClient.SearchTeamFoldersPagedResponse searchTeamFolders(SearchTeamFoldersRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   SearchTeamFoldersRequest request =
       SearchTeamFoldersRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   for (SearchTeamFoldersResponse.TeamFolderSearchResult element :
       dataformClient.searchTeamFolders(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`SearchTeamFoldersRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataformClient.SearchTeamFoldersPagedResponse`

searchTeamFoldersCallable()

public final UnaryCallable<SearchTeamFoldersRequest,SearchTeamFoldersResponse> searchTeamFoldersCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   SearchTeamFoldersRequest request =
       SearchTeamFoldersRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   while (true) {
     SearchTeamFoldersResponse response =
         dataformClient.searchTeamFoldersCallable().call(request);
     for (SearchTeamFoldersResponse.TeamFolderSearchResult element : response.getResultsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<SearchTeamFoldersRequest,SearchTeamFoldersResponse>`

searchTeamFoldersPagedCallable()

public final UnaryCallable<SearchTeamFoldersRequest,DataformClient.SearchTeamFoldersPagedResponse> searchTeamFoldersPagedCallable()

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   SearchTeamFoldersRequest request =
       SearchTeamFoldersRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setOrderBy("orderBy-1207110587")
           .setFilter("filter-1274492040")
           .build();
   ApiFuture<SearchTeamFoldersResponse.TeamFolderSearchResult> future =
       dataformClient.searchTeamFoldersPagedCallable().futureCall(request);
   // Do something.
   for (SearchTeamFoldersResponse.TeamFolderSearchResult element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<SearchTeamFoldersRequest,SearchTeamFoldersPagedResponse>`

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = dataformClient.setIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = dataformClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = dataformClient.testIamPermissions(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(FolderName.of("[PROJECT]", "[LOCATION]", "[FOLDER]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       dataformClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

updateConfig(Config config, FieldMask updateMask)

public final Config updateConfig(Config config, FieldMask updateMask)

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.*

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   Config config = Config.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Config response = dataformClient.updateConfig(config, updateMask);
 }

Parameters
Name	Description
`config`	`Config` Required. The config to update.
`updateMask`	`FieldMask` Optional. Specifies the fields to be updated in the config.

Returns
Type	Description
`Config`

updateConfig(UpdateConfigRequest request)

public final Config updateConfig(UpdateConfigRequest request)

Update default config for a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateConfigRequest request =
       UpdateConfigRequest.newBuilder()
           .setConfig(Config.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Config response = dataformClient.updateConfig(request);
 }

Parameter
Name	Description
`request`	`UpdateConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Config`

updateConfigCallable()

public final UnaryCallable<UpdateConfigRequest,Config> updateConfigCallable()

Update default config for a given project and location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateConfigRequest request =
       UpdateConfigRequest.newBuilder()
           .setConfig(Config.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Config> future = dataformClient.updateConfigCallable().futureCall(request);
   // Do something.
   Config response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateConfigRequest,Config>`

updateFolder(Folder folder, FieldMask updateMask)

public final Folder updateFolder(Folder folder, FieldMask updateMask)

Updates a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   Folder folder = Folder.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Folder response = dataformClient.updateFolder(folder, updateMask);
 }

Parameters
Name	Description
`folder`	`Folder` Required. The updated Folder.
`updateMask`	`FieldMask` Optional. Specifies the fields to be updated in the Folder. If left unset, all fields that can be updated, will be updated. A few fields cannot be updated and will be ignored if specified in the update_mask (e.g. parent_name, team_folder_name).

Returns
Type	Description
`Folder`

updateFolder(UpdateFolderRequest request)

public final Folder updateFolder(UpdateFolderRequest request)

Updates a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateFolderRequest request =
       UpdateFolderRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setFolder(Folder.newBuilder().build())
           .build();
   Folder response = dataformClient.updateFolder(request);
 }

Parameter
Name	Description
`request`	`UpdateFolderRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Folder`

updateFolderCallable()

public final UnaryCallable<UpdateFolderRequest,Folder> updateFolderCallable()

Updates a single Folder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateFolderRequest request =
       UpdateFolderRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setFolder(Folder.newBuilder().build())
           .build();
   ApiFuture<Folder> future = dataformClient.updateFolderCallable().futureCall(request);
   // Do something.
   Folder response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateFolderRequest,Folder>`

updateReleaseConfig(ReleaseConfig releaseConfig, FieldMask updateMask)

public final ReleaseConfig updateReleaseConfig(ReleaseConfig releaseConfig, FieldMask updateMask)

Updates a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   ReleaseConfig releaseConfig = ReleaseConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ReleaseConfig response = dataformClient.updateReleaseConfig(releaseConfig, updateMask);
 }

Parameters
Name	Description
`releaseConfig`	`ReleaseConfig` Required. The release config to update.
`updateMask`	`FieldMask` Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.

Returns
Type	Description
`ReleaseConfig`

updateReleaseConfig(UpdateReleaseConfigRequest request)

public final ReleaseConfig updateReleaseConfig(UpdateReleaseConfigRequest request)

Updates a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateReleaseConfigRequest request =
       UpdateReleaseConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setReleaseConfig(ReleaseConfig.newBuilder().build())
           .build();
   ReleaseConfig response = dataformClient.updateReleaseConfig(request);
 }

Parameter
Name	Description
`request`	`UpdateReleaseConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ReleaseConfig`

updateReleaseConfigCallable()

public final UnaryCallable<UpdateReleaseConfigRequest,ReleaseConfig> updateReleaseConfigCallable()

Updates a single ReleaseConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateReleaseConfigRequest request =
       UpdateReleaseConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setReleaseConfig(ReleaseConfig.newBuilder().build())
           .build();
   ApiFuture<ReleaseConfig> future =
       dataformClient.updateReleaseConfigCallable().futureCall(request);
   // Do something.
   ReleaseConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateReleaseConfigRequest,ReleaseConfig>`

updateRepository(Repository repository, FieldMask updateMask)

public final Repository updateRepository(Repository repository, FieldMask updateMask)

Updates a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   Repository repository = Repository.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Repository response = dataformClient.updateRepository(repository, updateMask);
 }

Parameters
Name	Description
`repository`	`Repository` Required. The repository to update.
`updateMask`	`FieldMask` Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.

Returns
Type	Description
`Repository`

updateRepository(UpdateRepositoryRequest request)

public final Repository updateRepository(UpdateRepositoryRequest request)

Updates a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateRepositoryRequest request =
       UpdateRepositoryRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRepository(Repository.newBuilder().build())
           .build();
   Repository response = dataformClient.updateRepository(request);
 }

Parameter
Name	Description
`request`	`UpdateRepositoryRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Repository`

updateRepositoryCallable()

public final UnaryCallable<UpdateRepositoryRequest,Repository> updateRepositoryCallable()

Updates a single Repository.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateRepositoryRequest request =
       UpdateRepositoryRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setRepository(Repository.newBuilder().build())
           .build();
   ApiFuture<Repository> future = dataformClient.updateRepositoryCallable().futureCall(request);
   // Do something.
   Repository response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateRepositoryRequest,Repository>`

updateTeamFolder(TeamFolder teamFolder, FieldMask updateMask)

public final TeamFolder updateTeamFolder(TeamFolder teamFolder, FieldMask updateMask)

Updates a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   TeamFolder teamFolder = TeamFolder.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   TeamFolder response = dataformClient.updateTeamFolder(teamFolder, updateMask);
 }

Parameters
Name	Description
`teamFolder`	`TeamFolder` Required. The updated TeamFolder.
`updateMask`	`FieldMask` Optional. Specifies the fields to be updated in the Folder. If left unset, all fields will be updated.

Returns
Type	Description
`TeamFolder`

updateTeamFolder(UpdateTeamFolderRequest request)

public final TeamFolder updateTeamFolder(UpdateTeamFolderRequest request)

Updates a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateTeamFolderRequest request =
       UpdateTeamFolderRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTeamFolder(TeamFolder.newBuilder().build())
           .build();
   TeamFolder response = dataformClient.updateTeamFolder(request);
 }

Parameter
Name	Description
`request`	`UpdateTeamFolderRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`TeamFolder`

updateTeamFolderCallable()

public final UnaryCallable<UpdateTeamFolderRequest,TeamFolder> updateTeamFolderCallable()

Updates a single TeamFolder.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateTeamFolderRequest request =
       UpdateTeamFolderRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTeamFolder(TeamFolder.newBuilder().build())
           .build();
   ApiFuture<TeamFolder> future = dataformClient.updateTeamFolderCallable().futureCall(request);
   // Do something.
   TeamFolder response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateTeamFolderRequest,TeamFolder>`

updateWorkflowConfig(UpdateWorkflowConfigRequest request)

public final WorkflowConfig updateWorkflowConfig(UpdateWorkflowConfigRequest request)

Updates a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateWorkflowConfigRequest request =
       UpdateWorkflowConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setWorkflowConfig(WorkflowConfig.newBuilder().build())
           .build();
   WorkflowConfig response = dataformClient.updateWorkflowConfig(request);
 }

Parameter
Name	Description
`request`	`UpdateWorkflowConfigRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`WorkflowConfig`

updateWorkflowConfig(WorkflowConfig workflowConfig, FieldMask updateMask)

public final WorkflowConfig updateWorkflowConfig(WorkflowConfig workflowConfig, FieldMask updateMask)

Updates a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WorkflowConfig workflowConfig = WorkflowConfig.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   WorkflowConfig response = dataformClient.updateWorkflowConfig(workflowConfig, updateMask);
 }

Parameters
Name	Description
`workflowConfig`	`WorkflowConfig` Required. The workflow config to update.
`updateMask`	`FieldMask` Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.

Returns
Type	Description
`WorkflowConfig`

updateWorkflowConfigCallable()

public final UnaryCallable<UpdateWorkflowConfigRequest,WorkflowConfig> updateWorkflowConfigCallable()

Updates a single WorkflowConfig.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   UpdateWorkflowConfigRequest request =
       UpdateWorkflowConfigRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setWorkflowConfig(WorkflowConfig.newBuilder().build())
           .build();
   ApiFuture<WorkflowConfig> future =
       dataformClient.updateWorkflowConfigCallable().futureCall(request);
   // Do something.
   WorkflowConfig response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateWorkflowConfigRequest,WorkflowConfig>`

writeFile(WriteFileRequest request)

public final WriteFileResponse writeFile(WriteFileRequest request)

Writes to a file (inside a Workspace).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WriteFileRequest request =
       WriteFileRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setContents(ByteString.EMPTY)
           .build();
   WriteFileResponse response = dataformClient.writeFile(request);
 }

Parameter
Name	Description
`request`	`WriteFileRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`WriteFileResponse`

writeFileCallable()

public final UnaryCallable<WriteFileRequest,WriteFileResponse> writeFileCallable()

Writes to a file (inside a Workspace).

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataformClient dataformClient = DataformClient.create()) {
   WriteFileRequest request =
       WriteFileRequest.newBuilder()
           .setWorkspace(
               WorkspaceName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[WORKSPACE]")
                   .toString())
           .setPath("path3433509")
           .setContents(ByteString.EMPTY)
           .build();
   ApiFuture<WriteFileResponse> future = dataformClient.writeFileCallable().futureCall(request);
   // Do something.
   WriteFileResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<WriteFileRequest,WriteFileResponse>`