Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/dataform:v1.ts";

§Classes

Dataform

Service to develop, version control, and operationalize SQL pipelines in BigQuery.

GoogleAuth

§Variables

auth

§Interfaces

ActionErrorTable

Error table information, used to write error data into a BigQuery table.

ActionIncrementalLoadMode

Load definition for incremental load modes

ActionLoadConfig

Simplified load configuration for actions

ActionSimpleLoadMode

Simple load definition

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 a role.

CancelOperationRequest

The request message for Operations.CancelOperation.

CancelWorkflowInvocationRequest

CancelWorkflowInvocation request message.

CancelWorkflowInvocationResponse

CancelWorkflowInvocation response message.

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

CommitRepositoryChanges request message.

CommitRepositoryChangesResponse

CommitRepositoryChanges response message.

CommitWorkspaceChangesRequest

CommitWorkspaceChanges request message.

CommitWorkspaceChangesResponse

CommitWorkspaceChanges response 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

ComputeRepositoryAccessTokenStatus response message.

Config

Config for all repositories in a given project and location.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

DataEncryptionState

Describes encryption state of a resource.

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.

DeleteFile

Represents the delete file operation.

DirectoryEntry

Represents a single entry in a directory.

DirectorySearchResult

Client-facing representation of a directory entry in search results.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

ErrorTable

Error table information, used to write error data into a BigQuery table.

Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

FetchFileDiffResponse

FetchFileDiff response message.

FetchFileGitStatusesResponse

FetchFileGitStatuses response message.

FetchGitAheadBehindResponse

FetchGitAheadBehind response message.

FetchRemoteBranchesResponse

FetchRemoteBranches response message.

FetchRepositoryHistoryResponse

FetchRepositoryHistory response message.

FileOperation

Represents a single file operation to the repository.

FileSearchResult

Client-facing representation of a file entry in search results.

GitRemoteSettings

Controls Git remote configuration for a repository.

IamPolicyOverrideView

Contains metadata about the IAM policy override for a given Dataform resource. If is_active is true, this the policy encoded in iam_policy_name is the source of truth for this resource. Will be provided in internal ESV2 views for: Workspaces, Repositories, Folders, TeamFolders.

IncrementalLoadMode

Load definition for incremental load modes

IncrementalTableConfig

Contains settings for relations of type INCREMENTAL_TABLE.

InstallNpmPackagesRequest

InstallNpmPackages request message.

InstallNpmPackagesResponse

InstallNpmPackages response message.

Interval

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

InvocationConfig

Includes various configuration options for a workflow invocation. If both included_targets and included_tags are unset, all actions will be included.

ListCompilationResultsResponse

ListCompilationResults response message.

ListLocationsResponse

The response message for Locations.ListLocations.

ListOperationsResponse

The response message for Operations.ListOperations.

ListReleaseConfigsResponse

ListReleaseConfigs response message.

ListRepositoriesResponse

ListRepositories response message.

ListWorkflowConfigsResponse

ListWorkflowConfigs response message.

ListWorkflowInvocationsResponse

ListWorkflowInvocations response message.

ListWorkspacesResponse

ListWorkspaces response message.

LoadConfig

Simplified load configuration for actions

Location

A resource that represents a Google Cloud location.

MakeDirectoryRequest

MakeDirectory request message.

MakeDirectoryResponse

MakeDirectory response message.

MoveDirectoryRequest

MoveDirectory request message.

MoveDirectoryResponse

MoveDirectory response message.

MoveFileRequest

MoveFile request message.

MoveFileResponse

MoveFile response 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.

OperationMetadata

Represents the metadata of the long-running operation.

Operations

Represents a list of arbitrary database operations.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: ``` bindings: - members:

PolicyName

An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names.

ProjectsLocationsFoldersGetIamPolicyOptions

Additional options for Dataform#projectsLocationsFoldersGetIamPolicy.

ProjectsLocationsListOptions

Additional options for Dataform#projectsLocationsList.

ProjectsLocationsOperationsListOptions

Additional options for Dataform#projectsLocationsOperationsList.

ProjectsLocationsRepositoriesCompilationResultsListOptions

Additional options for Dataform#projectsLocationsRepositoriesCompilationResultsList.

ProjectsLocationsRepositoriesCompilationResultsQueryOptions

Additional options for Dataform#projectsLocationsRepositoriesCompilationResultsQuery.

ProjectsLocationsRepositoriesCreateOptions

Additional options for Dataform#projectsLocationsRepositoriesCreate.

ProjectsLocationsRepositoriesDeleteOptions

Additional options for Dataform#projectsLocationsRepositoriesDelete.

ProjectsLocationsRepositoriesFetchHistoryOptions

Additional options for Dataform#projectsLocationsRepositoriesFetchHistory.

ProjectsLocationsRepositoriesGetIamPolicyOptions

Additional options for Dataform#projectsLocationsRepositoriesGetIamPolicy.

ProjectsLocationsRepositoriesListOptions

Additional options for Dataform#projectsLocationsRepositoriesList.

ProjectsLocationsRepositoriesPatchOptions

Additional options for Dataform#projectsLocationsRepositoriesPatch.

ProjectsLocationsRepositoriesQueryDirectoryContentsOptions

Additional options for Dataform#projectsLocationsRepositoriesQueryDirectoryContents.

ProjectsLocationsRepositoriesReadFileOptions

Additional options for Dataform#projectsLocationsRepositoriesReadFile.

ProjectsLocationsRepositoriesReleaseConfigsCreateOptions

Additional options for Dataform#projectsLocationsRepositoriesReleaseConfigsCreate.

ProjectsLocationsRepositoriesReleaseConfigsListOptions

Additional options for Dataform#projectsLocationsRepositoriesReleaseConfigsList.

ProjectsLocationsRepositoriesReleaseConfigsPatchOptions

Additional options for Dataform#projectsLocationsRepositoriesReleaseConfigsPatch.

ProjectsLocationsRepositoriesWorkflowConfigsCreateOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkflowConfigsCreate.

ProjectsLocationsRepositoriesWorkflowConfigsListOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkflowConfigsList.

ProjectsLocationsRepositoriesWorkflowConfigsPatchOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkflowConfigsPatch.

ProjectsLocationsRepositoriesWorkflowInvocationsListOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkflowInvocationsList.

ProjectsLocationsRepositoriesWorkflowInvocationsQueryOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkflowInvocationsQuery.

ProjectsLocationsRepositoriesWorkspacesCreateOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkspacesCreate.

ProjectsLocationsRepositoriesWorkspacesFetchFileDiffOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkspacesFetchFileDiff.

ProjectsLocationsRepositoriesWorkspacesFetchGitAheadBehindOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkspacesFetchGitAheadBehind.

ProjectsLocationsRepositoriesWorkspacesGetIamPolicyOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkspacesGetIamPolicy.

ProjectsLocationsRepositoriesWorkspacesListOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkspacesList.

ProjectsLocationsRepositoriesWorkspacesQueryDirectoryContentsOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkspacesQueryDirectoryContents.

ProjectsLocationsRepositoriesWorkspacesReadFileOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkspacesReadFile.

ProjectsLocationsRepositoriesWorkspacesSearchFilesOptions

Additional options for Dataform#projectsLocationsRepositoriesWorkspacesSearchFiles.

ProjectsLocationsTeamFoldersGetIamPolicyOptions

Additional options for Dataform#projectsLocationsTeamFoldersGetIamPolicy.

ProjectsLocationsUpdateConfigOptions

Additional options for Dataform#projectsLocationsUpdateConfig.

PullGitCommitsRequest

PullGitCommits request message.

PullGitCommitsResponse

PullGitCommits response message.

PushGitCommitsRequest

PushGitCommits request message.

PushGitCommitsResponse

PushGitCommits response message.

QueryCompilationResultActionsResponse

QueryCompilationResultActions response message.

QueryDirectoryContentsResponse

QueryDirectoryContents response message.

QueryRepositoryDirectoryContentsResponse

QueryRepositoryDirectoryContents response message.

QueryWorkflowInvocationActionsResponse

QueryWorkflowInvocationActions response message.

ReadFileResponse

ReadFile response message.

ReadRepositoryFileResponse

ReadRepositoryFile response message.

Relation

Represents a database relation.

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.

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 SetIamPolicy method.

SimpleLoadMode

Simple load definition

SqlDefinition

Definition of a SQL Data Preparation

SshAuthenticationConfig

Configures fields for performing SSH authentication.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Target

Represents an action identifier. If the action writes output, the output will be written to the referenced database object.

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

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.

WriteFile

Represents the write file operation (for files added or modified).

WriteFileRequest

WriteFile request message.

WriteFileResponse

WriteFile response message.