Skip to main content

Module model

Module model 

Source
Expand description

The messages and enums that are part of this client library.

Modules§

commit_repository_changes_request
Defines additional types related to CommitRepositoryChangesRequest.
compilation_result
Defines additional types related to CompilationResult.
compilation_result_action
Defines additional types related to CompilationResultAction.
compute_repository_access_token_status_response
Defines additional types related to ComputeRepositoryAccessTokenStatusResponse.
delete_folder_tree_metadata
Defines additional types related to DeleteFolderTreeMetadata.
directory_entry
Defines additional types related to DirectoryEntry.
fetch_file_git_statuses_response
Defines additional types related to FetchFileGitStatusesResponse.
invocation_config
Defines additional types related to InvocationConfig.
move_folder_metadata
Defines additional types related to MoveFolderMetadata.
move_repository_metadata
Defines additional types related to MoveRepositoryMetadata.
notebook_runtime_options
Defines additional types related to NotebookRuntimeOptions.
query_folder_contents_response
Defines additional types related to QueryFolderContentsResponse.
query_team_folder_contents_response
Defines additional types related to QueryTeamFolderContentsResponse.
query_user_root_contents_response
Defines additional types related to QueryUserRootContentsResponse.
relation_descriptor
Defines additional types related to RelationDescriptor.
release_config
Defines additional types related to ReleaseConfig.
repository
Defines additional types related to Repository.
search_result
Defines additional types related to SearchResult.
search_team_folders_response
Defines additional types related to SearchTeamFoldersResponse.
workflow_config
Defines additional types related to WorkflowConfig.
workflow_invocation
Defines additional types related to WorkflowInvocation.
workflow_invocation_action
Defines additional types related to WorkflowInvocationAction.

Structs§

CancelWorkflowInvocationRequest
CancelWorkflowInvocation request message.
CancelWorkflowInvocationResponse
CancelWorkflowInvocation response message.
CodeCompilationConfig
Configures various aspects of Dataform code compilation.
CommitAuthor
Represents the author of a Git commit.
CommitLogEntry
Represents a single commit log.
CommitMetadata
Represents a Dataform Git commit.
CommitRepositoryChangesRequest
CommitRepositoryChanges request message.
CommitRepositoryChangesResponse
CommitRepositoryChanges response message.
CommitWorkspaceChangesRequest
CommitWorkspaceChanges request message.
CommitWorkspaceChangesResponse
CommitWorkspaceChanges response message.
CompilationResult
Represents the result of compiling a Dataform project.
CompilationResultAction
Represents a single Dataform action in a compilation result.
ComputeRepositoryAccessTokenStatusRequest
ComputeRepositoryAccessTokenStatus request message.
ComputeRepositoryAccessTokenStatusResponse
ComputeRepositoryAccessTokenStatus response message.
Config
Config for all repositories in a given project and location.
CreateCompilationResultRequest
CreateCompilationResult request message.
CreateFolderRequest
CreateFolder request message.
CreateReleaseConfigRequest
CreateReleaseConfig request message.
CreateRepositoryRequest
CreateRepository request message.
CreateTeamFolderRequest
CreateTeamFolder request message.
CreateWorkflowConfigRequest
CreateWorkflowConfig request message.
CreateWorkflowInvocationRequest
CreateWorkflowInvocation request message.
CreateWorkspaceRequest
CreateWorkspace request message.
DataEncryptionState
Describes encryption state of a resource.
DeleteFolderRequest
DeleteFolder request message.
DeleteFolderTreeMetadata
Contains metadata about the progress of the DeleteFolderTree Long-running operations.
DeleteFolderTreeRequest
DeleteFolderTree request message.
DeleteReleaseConfigRequest
DeleteReleaseConfig request message.
DeleteRepositoryRequest
DeleteRepository request message.
DeleteTeamFolderRequest
DeleteTeamFolder request message.
DeleteTeamFolderTreeRequest
DeleteTeamFolderTree request message.
DeleteWorkflowConfigRequest
DeleteWorkflowConfig request message.
DeleteWorkflowInvocationRequest
DeleteWorkflowInvocation request message.
DeleteWorkspaceRequest
DeleteWorkspace request message.
DirectoryEntry
Represents a single entry in a directory.
DirectorySearchResult
Client-facing representation of a directory entry in search results.
FetchFileDiffRequest
FetchFileDiff request message.
FetchFileDiffResponse
FetchFileDiff response message.
FetchFileGitStatusesRequest
FetchFileGitStatuses request message.
FetchFileGitStatusesResponse
FetchFileGitStatuses response message.
FetchGitAheadBehindRequest
FetchGitAheadBehind request message.
FetchGitAheadBehindResponse
FetchGitAheadBehind response message.
FetchRemoteBranchesRequest
FetchRemoteBranches request message.
FetchRemoteBranchesResponse
FetchRemoteBranches response message.
FetchRepositoryHistoryRequest
FetchRepositoryHistory request message.
FetchRepositoryHistoryResponse
FetchRepositoryHistory response message.
FileSearchResult
Client-facing representation of a file entry in search results.
FilesystemEntryMetadata
Represents metadata for a single entry in a filesystem.
Folder
Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls.
GetCompilationResultRequest
GetCompilationResult request message.
GetConfigRequest
GetConfig request message.
GetFolderRequest
GetFolder request message.
GetReleaseConfigRequest
GetReleaseConfig request message.
GetRepositoryRequest
GetRepository request message.
GetTeamFolderRequest
GetTeamFolder request message.
GetWorkflowConfigRequest
GetWorkflowConfig request message.
GetWorkflowInvocationRequest
GetWorkflowInvocation request message.
GetWorkspaceRequest
GetWorkspace request message.
InstallNpmPackagesRequest
InstallNpmPackages request message.
InstallNpmPackagesResponse
InstallNpmPackages response message.
InvocationConfig
Includes various configuration options for a workflow invocation. If both included_targets and included_tags are unset, all actions will be included.
ListCompilationResultsRequest
ListCompilationResults request message.
ListCompilationResultsResponse
ListCompilationResults response message.
ListReleaseConfigsRequest
ListReleaseConfigs request message.
ListReleaseConfigsResponse
ListReleaseConfigs response message.
ListRepositoriesRequest
ListRepositories request message.
ListRepositoriesResponse
ListRepositories response message.
ListWorkflowConfigsRequest
ListWorkflowConfigs request message.
ListWorkflowConfigsResponse
ListWorkflowConfigs response message.
ListWorkflowInvocationsRequest
ListWorkflowInvocations request message.
ListWorkflowInvocationsResponse
ListWorkflowInvocations response message.
ListWorkspacesRequest
ListWorkspaces request message.
ListWorkspacesResponse
ListWorkspaces response message.
MakeDirectoryRequest
MakeDirectory request message.
MakeDirectoryResponse
MakeDirectory response message.
MoveDirectoryRequest
MoveDirectory request message.
MoveDirectoryResponse
MoveDirectory response message.
MoveFileRequest
MoveFile request message.
MoveFileResponse
MoveFile response message.
MoveFolderMetadata
Contains metadata about the progress of the MoveFolder Long-running operations.
MoveFolderRequest
MoveFolder request message.
MoveRepositoryMetadata
Contains metadata about the progress of the MoveRepository Long-running operations.
MoveRepositoryRequest
MoveRepository request message.
NotebookRuntimeOptions
Configures various aspects of Dataform notebook runtime.
PrivateResourceMetadata
Metadata used to identify if a resource is user scoped.
PullGitCommitsRequest
PullGitCommits request message.
PullGitCommitsResponse
PullGitCommits response message.
PushGitCommitsRequest
PushGitCommits request message.
PushGitCommitsResponse
PushGitCommits response message.
QueryCompilationResultActionsRequest
QueryCompilationResultActions request message.
QueryCompilationResultActionsResponse
QueryCompilationResultActions response message.
QueryDirectoryContentsRequest
QueryDirectoryContents request message.
QueryDirectoryContentsResponse
QueryDirectoryContents response message.
QueryFolderContentsRequest
QueryFolderContents request message.
QueryFolderContentsResponse
QueryFolderContents response message.
QueryRepositoryDirectoryContentsRequest
QueryRepositoryDirectoryContents request message.
QueryRepositoryDirectoryContentsResponse
QueryRepositoryDirectoryContents response message.
QueryTeamFolderContentsRequest
QueryTeamFolderContents request message.
QueryTeamFolderContentsResponse
QueryTeamFolderContents response message.
QueryUserRootContentsRequest
QueryUserRootContents request message.
QueryUserRootContentsResponse
QueryUserRootContents response message.
QueryWorkflowInvocationActionsRequest
QueryWorkflowInvocationActions request message.
QueryWorkflowInvocationActionsResponse
QueryWorkflowInvocationActions response message.
ReadFileRequest
ReadFile request message.
ReadFileResponse
ReadFile response message.
ReadRepositoryFileRequest
ReadRepositoryFile request message.
ReadRepositoryFileResponse
ReadRepositoryFile response message.
RelationDescriptor
Describes a relation and its columns.
ReleaseConfig
Represents a Dataform release configuration.
RemoveDirectoryRequest
RemoveDirectory request message.
RemoveDirectoryResponse
RemoveDirectory response message.
RemoveFileRequest
RemoveFile request message.
RemoveFileResponse
RemoveFile response message.
Repository
Represents a Dataform Git repository.
ResetWorkspaceChangesRequest
ResetWorkspaceChanges request message.
ResetWorkspaceChangesResponse
ResetWorkspaceChanges response message.
SearchFilesRequest
Configuration containing file search request parameters.
SearchFilesResponse
Client-facing representation of a file search response.
SearchResult
Client-facing representation of a search result entry.
SearchTeamFoldersRequest
SearchTeamFolders request message.
SearchTeamFoldersResponse
SearchTeamFolders response message.
Target
Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
TeamFolder
Represents a Dataform TeamFolder. This is a resource that sits at the project level and is used to organize Repositories and Folders with hierarchical access controls. They provide a team context and stricter access controls.
UpdateConfigRequest
UpdateConfig request message.
UpdateFolderRequest
UpdateFolder request message.
UpdateReleaseConfigRequest
UpdateReleaseConfig request message.
UpdateRepositoryRequest
UpdateRepository request message.
UpdateTeamFolderRequest
UpdateTeamFolder request message.
UpdateWorkflowConfigRequest
UpdateWorkflowConfig request message.
WorkflowConfig
Represents a Dataform workflow configuration.
WorkflowInvocation
Represents a single invocation of a compilation result.
WorkflowInvocationAction
Represents a single action in a workflow invocation.
Workspace
Represents a Dataform Git workspace.
WriteFileRequest
WriteFile request message.
WriteFileResponse
WriteFile response message.

Enums§

DirectoryContentsView
Represents the level of detail to return for directory contents.