Summary of entries of Classes for dataform.
Classes
DataformAsyncClient
Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.
DataformClient
Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.
FetchRepositoryHistoryAsyncPager
A pager for iterating through fetch_repository_history requests.
This class thinly wraps an initial
FetchRepositoryHistoryResponse object, and
provides an __aiter__ method to iterate through its
commits field.
If there are more pages, the __aiter__ method will make additional
FetchRepositoryHistory requests and continue to iterate
through the commits field on the
corresponding responses.
All the usual FetchRepositoryHistoryResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
FetchRepositoryHistoryPager
A pager for iterating through fetch_repository_history requests.
This class thinly wraps an initial
FetchRepositoryHistoryResponse object, and
provides an __iter__ method to iterate through its
commits field.
If there are more pages, the __iter__ method will make additional
FetchRepositoryHistory requests and continue to iterate
through the commits field on the
corresponding responses.
All the usual FetchRepositoryHistoryResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListCompilationResultsAsyncPager
A pager for iterating through list_compilation_results requests.
This class thinly wraps an initial
ListCompilationResultsResponse object, and
provides an __aiter__ method to iterate through its
compilation_results field.
If there are more pages, the __aiter__ method will make additional
ListCompilationResults requests and continue to iterate
through the compilation_results field on the
corresponding responses.
All the usual ListCompilationResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListCompilationResultsPager
A pager for iterating through list_compilation_results requests.
This class thinly wraps an initial
ListCompilationResultsResponse object, and
provides an __iter__ method to iterate through its
compilation_results field.
If there are more pages, the __iter__ method will make additional
ListCompilationResults requests and continue to iterate
through the compilation_results field on the
corresponding responses.
All the usual ListCompilationResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListReleaseConfigsAsyncPager
A pager for iterating through list_release_configs requests.
This class thinly wraps an initial
ListReleaseConfigsResponse object, and
provides an __aiter__ method to iterate through its
release_configs field.
If there are more pages, the __aiter__ method will make additional
ListReleaseConfigs requests and continue to iterate
through the release_configs field on the
corresponding responses.
All the usual ListReleaseConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListReleaseConfigsPager
A pager for iterating through list_release_configs requests.
This class thinly wraps an initial
ListReleaseConfigsResponse object, and
provides an __iter__ method to iterate through its
release_configs field.
If there are more pages, the __iter__ method will make additional
ListReleaseConfigs requests and continue to iterate
through the release_configs field on the
corresponding responses.
All the usual ListReleaseConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListRepositoriesAsyncPager
A pager for iterating through list_repositories requests.
This class thinly wraps an initial
ListRepositoriesResponse object, and
provides an __aiter__ method to iterate through its
repositories field.
If there are more pages, the __aiter__ method will make additional
ListRepositories requests and continue to iterate
through the repositories field on the
corresponding responses.
All the usual ListRepositoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListRepositoriesPager
A pager for iterating through list_repositories requests.
This class thinly wraps an initial
ListRepositoriesResponse object, and
provides an __iter__ method to iterate through its
repositories field.
If there are more pages, the __iter__ method will make additional
ListRepositories requests and continue to iterate
through the repositories field on the
corresponding responses.
All the usual ListRepositoriesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListWorkflowConfigsAsyncPager
A pager for iterating through list_workflow_configs requests.
This class thinly wraps an initial
ListWorkflowConfigsResponse object, and
provides an __aiter__ method to iterate through its
workflow_configs field.
If there are more pages, the __aiter__ method will make additional
ListWorkflowConfigs requests and continue to iterate
through the workflow_configs field on the
corresponding responses.
All the usual ListWorkflowConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListWorkflowConfigsPager
A pager for iterating through list_workflow_configs requests.
This class thinly wraps an initial
ListWorkflowConfigsResponse object, and
provides an __iter__ method to iterate through its
workflow_configs field.
If there are more pages, the __iter__ method will make additional
ListWorkflowConfigs requests and continue to iterate
through the workflow_configs field on the
corresponding responses.
All the usual ListWorkflowConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListWorkflowInvocationsAsyncPager
A pager for iterating through list_workflow_invocations requests.
This class thinly wraps an initial
ListWorkflowInvocationsResponse object, and
provides an __aiter__ method to iterate through its
workflow_invocations field.
If there are more pages, the __aiter__ method will make additional
ListWorkflowInvocations requests and continue to iterate
through the workflow_invocations field on the
corresponding responses.
All the usual ListWorkflowInvocationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListWorkflowInvocationsPager
A pager for iterating through list_workflow_invocations requests.
This class thinly wraps an initial
ListWorkflowInvocationsResponse object, and
provides an __iter__ method to iterate through its
workflow_invocations field.
If there are more pages, the __iter__ method will make additional
ListWorkflowInvocations requests and continue to iterate
through the workflow_invocations field on the
corresponding responses.
All the usual ListWorkflowInvocationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListWorkspacesAsyncPager
A pager for iterating through list_workspaces requests.
This class thinly wraps an initial
ListWorkspacesResponse object, and
provides an __aiter__ method to iterate through its
workspaces field.
If there are more pages, the __aiter__ method will make additional
ListWorkspaces requests and continue to iterate
through the workspaces field on the
corresponding responses.
All the usual ListWorkspacesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListWorkspacesPager
A pager for iterating through list_workspaces requests.
This class thinly wraps an initial
ListWorkspacesResponse object, and
provides an __iter__ method to iterate through its
workspaces field.
If there are more pages, the __iter__ method will make additional
ListWorkspaces requests and continue to iterate
through the workspaces field on the
corresponding responses.
All the usual ListWorkspacesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryCompilationResultActionsAsyncPager
A pager for iterating through query_compilation_result_actions requests.
This class thinly wraps an initial
QueryCompilationResultActionsResponse object, and
provides an __aiter__ method to iterate through its
compilation_result_actions field.
If there are more pages, the __aiter__ method will make additional
QueryCompilationResultActions requests and continue to iterate
through the compilation_result_actions field on the
corresponding responses.
All the usual QueryCompilationResultActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryCompilationResultActionsPager
A pager for iterating through query_compilation_result_actions requests.
This class thinly wraps an initial
QueryCompilationResultActionsResponse object, and
provides an __iter__ method to iterate through its
compilation_result_actions field.
If there are more pages, the __iter__ method will make additional
QueryCompilationResultActions requests and continue to iterate
through the compilation_result_actions field on the
corresponding responses.
All the usual QueryCompilationResultActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryDirectoryContentsAsyncPager
A pager for iterating through query_directory_contents requests.
This class thinly wraps an initial
QueryDirectoryContentsResponse object, and
provides an __aiter__ method to iterate through its
directory_entries field.
If there are more pages, the __aiter__ method will make additional
QueryDirectoryContents requests and continue to iterate
through the directory_entries field on the
corresponding responses.
All the usual QueryDirectoryContentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryDirectoryContentsPager
A pager for iterating through query_directory_contents requests.
This class thinly wraps an initial
QueryDirectoryContentsResponse object, and
provides an __iter__ method to iterate through its
directory_entries field.
If there are more pages, the __iter__ method will make additional
QueryDirectoryContents requests and continue to iterate
through the directory_entries field on the
corresponding responses.
All the usual QueryDirectoryContentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryRepositoryDirectoryContentsAsyncPager
A pager for iterating through query_repository_directory_contents requests.
This class thinly wraps an initial
QueryRepositoryDirectoryContentsResponse object, and
provides an __aiter__ method to iterate through its
directory_entries field.
If there are more pages, the __aiter__ method will make additional
QueryRepositoryDirectoryContents requests and continue to iterate
through the directory_entries field on the
corresponding responses.
All the usual QueryRepositoryDirectoryContentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryRepositoryDirectoryContentsPager
A pager for iterating through query_repository_directory_contents requests.
This class thinly wraps an initial
QueryRepositoryDirectoryContentsResponse object, and
provides an __iter__ method to iterate through its
directory_entries field.
If there are more pages, the __iter__ method will make additional
QueryRepositoryDirectoryContents requests and continue to iterate
through the directory_entries field on the
corresponding responses.
All the usual QueryRepositoryDirectoryContentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryWorkflowInvocationActionsAsyncPager
A pager for iterating through query_workflow_invocation_actions requests.
This class thinly wraps an initial
QueryWorkflowInvocationActionsResponse object, and
provides an __aiter__ method to iterate through its
workflow_invocation_actions field.
If there are more pages, the __aiter__ method will make additional
QueryWorkflowInvocationActions requests and continue to iterate
through the workflow_invocation_actions field on the
corresponding responses.
All the usual QueryWorkflowInvocationActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
QueryWorkflowInvocationActionsPager
A pager for iterating through query_workflow_invocation_actions requests.
This class thinly wraps an initial
QueryWorkflowInvocationActionsResponse object, and
provides an __iter__ method to iterate through its
workflow_invocation_actions field.
If there are more pages, the __iter__ method will make additional
QueryWorkflowInvocationActions requests and continue to iterate
through the workflow_invocation_actions field on the
corresponding responses.
All the usual QueryWorkflowInvocationActionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
CancelWorkflowInvocationRequest
CancelWorkflowInvocation request message.
CodeCompilationConfig
Configures various aspects of Dataform code compilation.
VarsEntry
The abstract base class for a message.
CommitAuthor
Represents the author of a Git commit.
CommitLogEntry
Represents a single commit log.
CommitMetadata
Represents a Dataform Git commit.
CommitRepositoryChangesRequest
CommitRepositoryChanges request message.
FileOperation
Represents a single file operation to the repository.
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
DeleteFile
Represents the delete file operation.
WriteFile
Represents the write file operation (for files added or modified).
FileOperationsEntry
The abstract base class for a message.
CommitWorkspaceChangesRequest
CommitWorkspaceChanges request 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
CompilationError
An error encountered when attempting to compile a Dataform project.
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
Assertion
Represents an assertion upon a SQL query which is required return zero rows.
Declaration
Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions.
Operations
Represents a list of arbitrary database operations.
Relation
Represents a database relation.
AdditionalOptionsEntry
The abstract base class for a message.
IncrementalTableConfig
Contains settings for relations of type INCREMENTAL_TABLE.
RelationType
Indicates the type of this relation.
ComputeRepositoryAccessTokenStatusRequest
ComputeRepositoryAccessTokenStatus request message.
ComputeRepositoryAccessTokenStatusResponse
ComputeRepositoryAccessTokenStatus response message.
TokenStatus
Indicates the status of a Git authentication token.
CreateCompilationResultRequest
CreateCompilationResult request message.
CreateReleaseConfigRequest
CreateReleaseConfig request message.
CreateRepositoryRequest
CreateRepository request message.
CreateWorkflowConfigRequest
CreateWorkflowConfig request message.
CreateWorkflowInvocationRequest
CreateWorkflowInvocation request message.
CreateWorkspaceRequest
CreateWorkspace request message.
DeleteReleaseConfigRequest
DeleteReleaseConfig request message.
DeleteRepositoryRequest
DeleteRepository 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
FetchFileDiffRequest
FetchFileDiff request message.
FetchFileDiffResponse
FetchFileDiff response message.
FetchFileGitStatusesRequest
FetchFileGitStatuses request message.
FetchFileGitStatusesResponse
FetchFileGitStatuses response message.
UncommittedFileChange
Represents the Git state of a file with uncommitted changes.
State
Indicates the status of an uncommitted file change.
FetchGitAheadBehindRequest
FetchGitAheadBehind request message.
FetchGitAheadBehindResponse
FetchGitAheadBehind response message.
FetchRemoteBranchesRequest
FetchRemoteBranches request message.
FetchRemoteBranchesResponse
FetchRemoteBranches response message.
FetchRepositoryHistoryRequest
FetchRepositoryHistory request message.
FetchRepositoryHistoryResponse
FetchRepositoryHistory response message.
GetCompilationResultRequest
GetCompilationResult request message.
GetReleaseConfigRequest
GetReleaseConfig request message.
GetRepositoryRequest
GetRepository 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.
PullGitCommitsRequest
PullGitCommits request message.
PushGitCommitsRequest
PushGitCommits request message.
QueryCompilationResultActionsRequest
QueryCompilationResultActions request message.
QueryCompilationResultActionsResponse
QueryCompilationResultActions response message.
QueryDirectoryContentsRequest
QueryDirectoryContents request message.
QueryDirectoryContentsResponse
QueryDirectoryContents response message.
QueryRepositoryDirectoryContentsRequest
QueryRepositoryDirectoryContents request message.
QueryRepositoryDirectoryContentsResponse
QueryRepositoryDirectoryContents 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.
BigqueryLabelsEntry
The abstract base class for a message.
ColumnDescriptor
Describes a column.
ReleaseConfig
Represents a Dataform release configuration.
ScheduledReleaseRecord
A record of an attempt to create a compilation result for this release config.
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
RemoveDirectoryRequest
RemoveDirectory request message.
RemoveFileRequest
RemoveFile request message.
Repository
Represents a Dataform Git repository.
GitRemoteSettings
Controls Git remote configuration for a repository.
SshAuthenticationConfig
Configures fields for performing SSH authentication.
TokenStatus
LabelsEntry
The abstract base class for a message.
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 incode_compilation_config(https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results.
ResetWorkspaceChangesRequest
ResetWorkspaceChanges request message.
Target
Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
UpdateReleaseConfigRequest
UpdateReleaseConfig request message.
UpdateRepositoryRequest
UpdateRepository request message.
UpdateWorkflowConfigRequest
UpdateWorkflowConfig request message.
WorkflowConfig
Represents a Dataform workflow configuration.
ScheduledExecutionRecord
A record of an attempt to create a workflow invocation for this workflow config.
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
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
State
Represents the current state of a workflow invocation.
WorkflowInvocationAction
Represents a single action in a workflow invocation.
BigQueryAction
Represents a workflow action that will run against BigQuery.
State
Represents the current state of a workflow invocation action.
Workspace
Represents a Dataform Git workspace.
WriteFileRequest
WriteFile request message.
WriteFileResponse
WriteFile response message.
Modules
pagers
API documentation for dataform_v1beta1.services.dataform.pagers module.