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.
CommitRepositoryChangesRequest.Types
Container for nested types declared in the CommitRepositoryChangesRequest message type.
CommitRepositoryChangesRequest.Types.FileOperation
Represents a single file operation to the repository.
CommitRepositoryChangesRequest.Types.FileOperation.Types
Container for nested types declared in the FileOperation message type.
CommitRepositoryChangesRequest.Types.FileOperation.Types.DeleteFile
Represents the delete file operation.
CommitRepositoryChangesRequest.Types.FileOperation.Types.WriteFile
Represents the write file operation (for files added or modified).
CommitRepositoryChangesResponse
CommitRepositoryChanges response message.
CommitWorkspaceChangesRequest
CommitWorkspaceChanges request message.
CommitWorkspaceChangesResponse
CommitWorkspaceChanges response message.
CompilationResult
Represents the result of compiling a Dataform project.
CompilationResult.Types
Container for nested types declared in the CompilationResult message type.
CompilationResult.Types.CompilationError
An error encountered when attempting to compile a Dataform project.
CompilationResultAction
Represents a single Dataform action in a compilation result.
CompilationResultAction.Types
Container for nested types declared in the CompilationResultAction message type.
CompilationResultAction.Types.Assertion
Represents an assertion upon a SQL query which is required return zero rows.
CompilationResultAction.Types.DataPreparation
Defines a compiled Data Preparation entity
CompilationResultAction.Types.DataPreparation.Types
Container for nested types declared in the DataPreparation message type.
CompilationResultAction.Types.DataPreparation.Types.ErrorTable
Error table information, used to write error data into a BigQuery table.
CompilationResultAction.Types.DataPreparation.Types.SqlDefinition
Definition of a SQL Data Preparation
CompilationResultAction.Types.Declaration
Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.
CompilationResultAction.Types.IncrementalLoadMode
Load definition for incremental load modes
CompilationResultAction.Types.LoadConfig
Simplified load configuration for actions
CompilationResultAction.Types.Notebook
Represents a notebook.
CompilationResultAction.Types.Operations
Represents a list of arbitrary database operations.
CompilationResultAction.Types.Relation
Represents a database relation.
CompilationResultAction.Types.Relation.Types
Container for nested types declared in the Relation message type.
CompilationResultAction.Types.Relation.Types.IncrementalTableConfig
Contains settings for relations of type INCREMENTAL_TABLE.
CompilationResultAction.Types.SimpleLoadMode
Simple load definition
CompilationResultName
Resource name for the CompilationResult resource.
ComputeRepositoryAccessTokenStatusRequest
ComputeRepositoryAccessTokenStatus request message.
ComputeRepositoryAccessTokenStatusResponse
ComputeRepositoryAccessTokenStatus response message.
ComputeRepositoryAccessTokenStatusResponse.Types
Container for nested types declared in the ComputeRepositoryAccessTokenStatusResponse message type.
Config
Config for all repositories in a given project and location.
ConfigName
Resource name for the Config resource.
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.
CryptoKeyName
Resource name for the CryptoKey resource.
CryptoKeyVersionName
Resource name for the CryptoKeyVersion resource.
DataEncryptionState
Describes encryption state of a resource.
Dataform
Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.
Dataform.DataformBase
Base class for server-side implementations of Dataform
Dataform.DataformClient
Client for Dataform
DataformClient
Dataform client wrapper, for convenient use.
DataformClientBuilder
Builder class for DataformClient to provide simple configuration of credentials, endpoint etc.
DataformClientImpl
Dataform client wrapper implementation, for convenient use.
DataformSettings
Settings for DataformClient instances.
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.
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.
FetchFileGitStatusesResponse.Types
Container for nested types declared in the FetchFileGitStatusesResponse message type.
FetchFileGitStatusesResponse.Types.UncommittedFileChange
Represents the Git state of a file with uncommitted changes.
FetchFileGitStatusesResponse.Types.UncommittedFileChange.Types
Container for nested types declared in the UncommittedFileChange message type.
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.
FolderName
Resource name for the Folder resource.
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.
InvocationConfig.Types
Container for nested types declared in the InvocationConfig message type.
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.
MoveFolderMetadata.Types
Container for nested types declared in the MoveFolderMetadata message type.
MoveFolderRequest
MoveFolder request message.
MoveRepositoryMetadata
Contains metadata about the progress of the MoveRepository Long-running operations.
MoveRepositoryMetadata.Types
Container for nested types declared in the MoveRepositoryMetadata message type.
MoveRepositoryRequest
MoveRepository request message.
NotebookRuntimeOptions
Configures various aspects of Dataform notebook runtime.
NotebookRuntimeTemplateName
Resource name for the NotebookRuntimeTemplate resource.
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.
QueryFolderContentsResponse.Types
Container for nested types declared in the QueryFolderContentsResponse message type.
QueryFolderContentsResponse.Types.FolderContentsEntry
Represents a single content entry.
QueryRepositoryDirectoryContentsRequest
QueryRepositoryDirectoryContents request message.
QueryRepositoryDirectoryContentsResponse
QueryRepositoryDirectoryContents response message.
QueryTeamFolderContentsRequest
QueryTeamFolderContents request message.
QueryTeamFolderContentsResponse
QueryTeamFolderContents response message.
QueryTeamFolderContentsResponse.Types
Container for nested types declared in the QueryTeamFolderContentsResponse message type.
QueryTeamFolderContentsResponse.Types.TeamFolderContentsEntry
Represents a single content entry.
QueryUserRootContentsRequest
QueryUserRootContents request message.
QueryUserRootContentsResponse
QueryUserRootContents response message.
QueryUserRootContentsResponse.Types
Container for nested types declared in the QueryUserRootContentsResponse message type.
QueryUserRootContentsResponse.Types.RootContentsEntry
Represents a single content entry.
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.
RelationDescriptor.Types
Container for nested types declared in the RelationDescriptor message type.
RelationDescriptor.Types.ColumnDescriptor
Describes a column.
ReleaseConfig
Represents a Dataform release configuration.
ReleaseConfig.Types
Container for nested types declared in the ReleaseConfig message type.
ReleaseConfig.Types.ScheduledReleaseRecord
A record of an attempt to create a compilation result for this release config.
ReleaseConfigName
Resource name for the ReleaseConfig resource.
RemoveDirectoryRequest
RemoveDirectory request message.
RemoveDirectoryResponse
RemoveDirectory response message.
RemoveFileRequest
RemoveFile request message.
RemoveFileResponse
RemoveFile response message.
Repository
Represents a Dataform Git repository.
Repository.Types
Container for nested types declared in the Repository message type.
Repository.Types.GitRemoteSettings
Controls Git remote configuration for a repository.
Repository.Types.GitRemoteSettings.Types
Container for nested types declared in the GitRemoteSettings message type.
Repository.Types.GitRemoteSettings.Types.SshAuthenticationConfig
Configures fields for performing SSH authentication.
Repository.Types.WorkspaceCompilationOverrides
Configures workspace compilation overrides for a repository. Primarily used
by the UI (console.cloud.google.com). schema_suffix and table_prefix
can have a special expression - ${workspaceName}, which refers to the
workspace name from which the compilation results will be created. API
callers are expected to resolve the expression in these overrides and
provide them explicitly in code_compilation_config
(https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig)
when creating workspace-scoped compilation results.
RepositoryName
Resource name for the Repository resource.
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.
SearchTeamFoldersResponse.Types
Container for nested types declared in the SearchTeamFoldersResponse message type.
SearchTeamFoldersResponse.Types.TeamFolderSearchResult
Represents a single content entry.
SecretVersionName
Resource name for the SecretVersion resource.
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.
TeamFolderName
Resource name for the TeamFolder resource.
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.
WorkflowConfig.Types
Container for nested types declared in the WorkflowConfig message type.
WorkflowConfig.Types.ScheduledExecutionRecord
A record of an attempt to create a workflow invocation for this workflow config.
WorkflowConfigName
Resource name for the WorkflowConfig resource.
WorkflowInvocation
Represents a single invocation of a compilation result.
WorkflowInvocation.Types
Container for nested types declared in the WorkflowInvocation message type.
WorkflowInvocationAction
Represents a single action in a workflow invocation.
WorkflowInvocationAction.Types
Container for nested types declared in the WorkflowInvocationAction message type.
WorkflowInvocationAction.Types.BigQueryAction
Represents a workflow action that will run against BigQuery.
WorkflowInvocationAction.Types.DataPreparationAction
Represents a workflow action that will run a Data Preparation.
WorkflowInvocationAction.Types.DataPreparationAction.Types
Container for nested types declared in the DataPreparationAction message type.
WorkflowInvocationAction.Types.DataPreparationAction.Types.ActionErrorTable
Error table information, used to write error data into a BigQuery table.
WorkflowInvocationAction.Types.DataPreparationAction.Types.ActionIncrementalLoadMode
Load definition for incremental load modes
WorkflowInvocationAction.Types.DataPreparationAction.Types.ActionLoadConfig
Simplified load configuration for actions
WorkflowInvocationAction.Types.DataPreparationAction.Types.ActionSimpleLoadMode
Simple load definition
WorkflowInvocationAction.Types.DataPreparationAction.Types.ActionSqlDefinition
Definition of a SQL Data Preparation
WorkflowInvocationAction.Types.NotebookAction
Represents a workflow action that will run against a Notebook runtime.
WorkflowInvocationName
Resource name for the WorkflowInvocation resource.
Workspace
Represents a Dataform Git workspace.
WorkspaceName
Resource name for the Workspace resource.
WriteFileRequest
WriteFile request message.
WriteFileResponse
WriteFile response message.
Enums
CommitRepositoryChangesRequest.Types.FileOperation.OperationOneofCase
Enum of possible cases for the "operation" oneof.
CompilationResult.SourceOneofCase
Enum of possible cases for the "source" oneof.
CompilationResultAction.CompiledObjectOneofCase
Enum of possible cases for the "compiled_object" oneof.
CompilationResultAction.Types.DataPreparation.DefinitionOneofCase
Enum of possible cases for the "definition" oneof.
CompilationResultAction.Types.LoadConfig.ModeOneofCase
Enum of possible cases for the "mode" oneof.
CompilationResultAction.Types.Relation.Types.FileFormat
Supported file formats for BigQuery tables.
CompilationResultAction.Types.Relation.Types.RelationType
Indicates the type of this relation.
CompilationResultAction.Types.Relation.Types.TableFormat
Supported table formats for BigQuery tables.
CompilationResultName.ResourceNameType
The possible contents of CompilationResultName.
ComputeRepositoryAccessTokenStatusResponse.Types.TokenStatus
Indicates the status of a Git authentication token.
ConfigName.ResourceNameType
The possible contents of ConfigName.
CryptoKeyName.ResourceNameType
The possible contents of CryptoKeyName.
CryptoKeyVersionName.ResourceNameType
The possible contents of CryptoKeyVersionName.
DirectoryEntry.EntryOneofCase
Enum of possible cases for the "entry" oneof.
FetchFileGitStatusesResponse.Types.UncommittedFileChange.Types.State
Indicates the status of an uncommitted file change.
FolderName.ResourceNameType
The possible contents of FolderName.
InvocationConfig.Types.QueryPriority
Types of priority for query execution in BigQuery.
MoveFolderMetadata.Types.State
Different states of the move.
MoveRepositoryMetadata.Types.State
Different states of the move.
NotebookRuntimeOptions.ExecutionSinkOneofCase
Enum of possible cases for the "execution_sink" oneof.
NotebookRuntimeTemplateName.ResourceNameType
The possible contents of NotebookRuntimeTemplateName.
QueryFolderContentsResponse.Types.FolderContentsEntry.EntryOneofCase
Enum of possible cases for the "entry" oneof.
QueryTeamFolderContentsResponse.Types.TeamFolderContentsEntry.EntryOneofCase
Enum of possible cases for the "entry" oneof.
QueryUserRootContentsResponse.Types.RootContentsEntry.EntryOneofCase
Enum of possible cases for the "entry" oneof.
ReleaseConfig.Types.ScheduledReleaseRecord.ResultOneofCase
Enum of possible cases for the "result" oneof.
ReleaseConfigName.ResourceNameType
The possible contents of ReleaseConfigName.
Repository.Types.GitRemoteSettings.Types.TokenStatus
The status of the authentication token.
RepositoryName.ResourceNameType
The possible contents of RepositoryName.
SearchResult.EntryOneofCase
Enum of possible cases for the "entry" oneof.
SearchTeamFoldersResponse.Types.TeamFolderSearchResult.EntryOneofCase
Enum of possible cases for the "entry" oneof.
SecretVersionName.ResourceNameType
The possible contents of SecretVersionName.
TeamFolderName.ResourceNameType
The possible contents of TeamFolderName.
WorkflowConfig.Types.ScheduledExecutionRecord.ResultOneofCase
Enum of possible cases for the "result" oneof.
WorkflowConfigName.ResourceNameType
The possible contents of WorkflowConfigName.
WorkflowInvocation.CompilationSourceOneofCase
Enum of possible cases for the "compilation_source" oneof.
WorkflowInvocation.Types.State
Represents the current state of a workflow invocation.
WorkflowInvocationAction.ActionOneofCase
Enum of possible cases for the "action" oneof.
WorkflowInvocationAction.Types.DataPreparationAction.DefinitionOneofCase
Enum of possible cases for the "definition" oneof.
WorkflowInvocationAction.Types.DataPreparationAction.Types.ActionLoadConfig.ModeOneofCase
Enum of possible cases for the "mode" oneof.
WorkflowInvocationAction.Types.State
Represents the current state of a workflow invocation action.
WorkflowInvocationName.ResourceNameType
The possible contents of WorkflowInvocationName.
WorkspaceName.ResourceNameType
The possible contents of WorkspaceName.