API documentation for dataform_v1beta1.types
package.
Classes
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CompilationResultAction
Represents a single Dataform action in a compilation result.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ComputeRepositoryAccessTokenStatusRequest
ComputeRepositoryAccessTokenStatus
request message.
ComputeRepositoryAccessTokenStatusResponse
ComputeRepositoryAccessTokenStatus
response message.
Config
Config for all repositories in a given project and location.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
DeleteReleaseConfigRequest
DeleteReleaseConfig
request message.
DeleteRepositoryRequest
DeleteRepository
request message.
DeleteTeamFolderRequest
DeleteTeamFolder
request message.
DeleteWorkflowConfigRequest
DeleteWorkflowConfig
request message.
DeleteWorkflowInvocationRequest
DeleteWorkflowInvocation
request message.
DeleteWorkspaceRequest
DeleteWorkspace
request message.
DirectoryEntry
Represents a single entry in a directory.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
Folder
Represents a Dataform Folder. This is a resource that is used to organize Files and other Folders and provide hierarchical access controls.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
MoveRepositoryMetadata
Contains metadata about the progress of the MoveRepository Long-running operations.
MoveRepositoryRequest
MoveRepository
request message.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
NotebookRuntimeOptions
Configures various aspects of Dataform notebook runtime.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RemoveDirectoryRequest
RemoveDirectory
request message.
RemoveDirectoryResponse
RemoveDirectory
response message.
RemoveFileRequest
RemoveFile
request message.
RemoveFileResponse
RemoveFile
response message.
Repository
Represents a Dataform Git repository.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
WorkflowInvocation
Represents a single invocation of a compilation result.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
WorkflowInvocationAction
Represents a single action in a workflow invocation.
This message has oneof
_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Workspace
Represents a Dataform Git workspace.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
WriteFileRequest
WriteFile
request message.
WriteFileResponse
WriteFile
response message.

