dataform/v1 library
Dataform API - v1
Service to develop, version control, and operationalize SQL pipelines in BigQuery.
For more information, see cloud.google.com/dataform/docs
Create an instance of DataformApi to access these resources:
Classes
- ActionErrorTable
- Error table information, used to write error data into a BigQuery table.
- ActionLoadConfig
- Simplified load configuration for actions
- ActionSqlDefinition
- Definition of a SQL Data Preparation
- Assertion
- Represents an assertion upon a SQL query which is required return zero rows.
- BigQueryAction
- Represents a workflow action that will run against BigQuery.
- Binding
-
Associates
members, or principals, with arole. - CodeCompilationConfig
- Configures various aspects of Dataform code compilation.
- ColumnDescriptor
- Describes a column.
- CommitAuthor
- Represents the author of a Git commit.
- CommitLogEntry
- Represents a single commit log.
- CommitMetadata
- Represents a Dataform Git commit.
- CommitRepositoryChangesRequest
-
CommitRepositoryChangesrequest message. - CommitRepositoryChangesResponse
-
CommitRepositoryChangesresponse message. - CommitWorkspaceChangesRequest
-
CommitWorkspaceChangesrequest message. - CompilationError
- An error encountered when attempting to compile a Dataform project.
- CompilationResult
- Represents the result of compiling a Dataform project.
- CompilationResultAction
- Represents a single Dataform action in a compilation result.
- ComputeRepositoryAccessTokenStatusResponse
-
ComputeRepositoryAccessTokenStatusresponse message. - Config
- Config for all repositories in a given project and location.
- DataEncryptionState
- Describes encryption state of a resource.
- DataformApi
- Service to develop, version control, and operationalize SQL pipelines in BigQuery.
- DataPreparation
- Defines a compiled Data Preparation entity
- DataPreparationAction
- Represents a workflow action that will run a Data Preparation.
- Declaration
- Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.
- DirectoryEntry
- Represents a single entry in a directory.
- ErrorTable
- Error table information, used to write error data into a BigQuery table.
- FetchFileDiffResponse
-
FetchFileDiffresponse message. - FetchFileGitStatusesResponse
-
FetchFileGitStatusesresponse message. - FetchGitAheadBehindResponse
-
FetchGitAheadBehindresponse message. - FetchRemoteBranchesResponse
-
FetchRemoteBranchesresponse message. - FetchRepositoryHistoryResponse
-
FetchRepositoryHistoryresponse message. - FileOperation
- Represents a single file operation to the repository.
- GitRemoteSettings
- Controls Git remote configuration for a repository.
- IncrementalTableConfig
-
Contains settings for relations of type
INCREMENTAL_TABLE. - InvocationConfig
- Includes various configuration options for a workflow invocation.
- ListCompilationResultsResponse
-
ListCompilationResultsresponse message. - ListLocationsResponse
- The response message for Locations.ListLocations.
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListReleaseConfigsResponse
-
ListReleaseConfigsresponse message. - ListRepositoriesResponse
-
ListRepositoriesresponse message. - ListWorkflowConfigsResponse
-
ListWorkflowConfigsresponse message. - ListWorkflowInvocationsResponse
-
ListWorkflowInvocationsresponse message. - ListWorkspacesResponse
-
ListWorkspacesresponse message. - LoadConfig
- Simplified load configuration for actions
- MoveDirectoryRequest
-
MoveDirectoryrequest message. - MoveFileRequest
-
MoveFilerequest message. - Notebook
- Represents a notebook.
- NotebookAction
- Represents a workflow action that will run against a Notebook runtime.
- NotebookRuntimeOptions
- Configures various aspects of Dataform notebook runtime.
- Operation
- This resource represents a long-running operation that is the result of a network API call.
- Operations
- Represents a list of arbitrary database operations.
- Policy
- An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.
- PrivateResourceMetadata
- Metadata used to identify if a resource is user scoped.
- ProjectsLocationsFoldersResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsRepositoriesCompilationResultsResource
- ProjectsLocationsRepositoriesReleaseConfigsResource
- ProjectsLocationsRepositoriesResource
- ProjectsLocationsRepositoriesWorkflowConfigsResource
- ProjectsLocationsRepositoriesWorkflowInvocationsResource
- ProjectsLocationsRepositoriesWorkspacesResource
- ProjectsLocationsResource
- ProjectsLocationsTeamFoldersResource
- ProjectsResource
- PullGitCommitsRequest
-
PullGitCommitsrequest message. - PushGitCommitsRequest
-
PushGitCommitsrequest message. - QueryCompilationResultActionsResponse
-
QueryCompilationResultActionsresponse message. - QueryDirectoryContentsResponse
-
QueryDirectoryContentsresponse message. - QueryRepositoryDirectoryContentsResponse
-
QueryRepositoryDirectoryContentsresponse message. - QueryWorkflowInvocationActionsResponse
-
QueryWorkflowInvocationActionsresponse message. - ReadFileResponse
-
ReadFileresponse message. - Relation
- Represents a database relation.
- RelationDescriptor
- Describes a relation and its columns.
- ReleaseConfig
- Represents a Dataform release configuration.
- RemoveFileRequest
-
RemoveFilerequest message. - Repository
- Represents a Dataform Git repository.
- ResetWorkspaceChangesRequest
-
ResetWorkspaceChangesrequest message. - ScheduledExecutionRecord
- A record of an attempt to create a workflow invocation for this workflow config.
- ScheduledReleaseRecord
- A record of an attempt to create a compilation result for this release config.
- SearchFilesResponse
- Client-facing representation of a file search response.
- SearchResult
- Client-facing representation of a search result entry.
- SetIamPolicyRequest
-
Request message for
SetIamPolicymethod. - SqlDefinition
- Definition of a SQL Data Preparation
- SshAuthenticationConfig
- Configures fields for performing SSH authentication.
- Target
- Represents an action identifier.
- UncommittedFileChange
- Represents the Git state of a file with uncommitted changes.
- 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.
- WorkspaceCompilationOverrides
- Configures workspace compilation overrides for a repository.
- WriteFileRequest
-
WriteFilerequest message.
Typedefs
- ActionIncrementalLoadMode = $IncrementalLoadMode
- Load definition for incremental load modes
- ActionSimpleLoadMode = $Empty
- Simple load definition
- CancelOperationRequest = $Empty
- The request message for Operations.CancelOperation.
- CancelWorkflowInvocationRequest = $Empty
-
CancelWorkflowInvocationrequest message. - CancelWorkflowInvocationResponse = $Empty
-
CancelWorkflowInvocationresponse message. - CommitWorkspaceChangesResponse = $Empty
-
CommitWorkspaceChangesresponse message. - DeleteFile = $Empty
- Represents the delete file operation.
- DirectorySearchResult = $SearchResult
- Client-facing representation of a directory entry in search results.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- Expr = $Expr
- Represents a textual expression in the Common Expression Language (CEL) syntax.
- FileSearchResult = $SearchResult
- Client-facing representation of a file entry in search results.
- IncrementalLoadMode = $IncrementalLoadMode
- Load definition for incremental load modes
- InstallNpmPackagesRequest = $Empty
-
InstallNpmPackagesrequest message. - InstallNpmPackagesResponse = $Empty
-
InstallNpmPackagesresponse message. - Interval = $Interval
- Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).
- Location = $Location00
- A resource that represents a Google Cloud location.
- MakeDirectoryRequest = $DirectoryRequest
-
MakeDirectoryrequest message. - MakeDirectoryResponse = $Empty
-
MakeDirectoryresponse message. - MoveDirectoryResponse = $Empty
-
MoveDirectoryresponse message. - MoveFileResponse = $Empty
-
MoveFileresponse message. - PullGitCommitsResponse = $Empty
-
PullGitCommitsresponse message. - PushGitCommitsResponse = $Empty
-
PushGitCommitsresponse message. - ReadRepositoryFileResponse = $Shared16
-
ReadRepositoryFileresponse message. - RemoveDirectoryRequest = $DirectoryRequest
-
RemoveDirectoryrequest message. - RemoveDirectoryResponse = $Empty
-
RemoveDirectoryresponse message. - RemoveFileResponse = $Empty
-
RemoveFileresponse message. - ResetWorkspaceChangesResponse = $Empty
-
ResetWorkspaceChangesresponse message. - SimpleLoadMode = $Empty
- Simple load definition
- Status = $Status00
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. - TestIamPermissionsRequest = $TestIamPermissionsRequest00
-
Request message for
TestIamPermissionsmethod. - TestIamPermissionsResponse = $PermissionsResponse
-
Response message for
TestIamPermissionsmethod. - WriteFile = $Shared16
- Represents the write file operation (for files added or modified).
- WriteFileResponse = $Empty
-
WriteFileresponse message.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.