Struct Dataform 

pub struct Dataform { /* private fields */ }

Implements a client for the Dataform API.

Example

let client = Dataform::builder().build().await?;
// use `client` to make requests to the Dataform API.

Service Description

Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.

Configuration

To configure Dataform use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://dataform.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

Dataform holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap Dataform in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl Dataform

pub fn builder() -> ClientBuilder

Returns a builder for Dataform.

let client = Dataform::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: Dataform + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn list_repositories(&self) -> ListRepositories

Lists Repositories in a given project and location.

Note: This method can return repositories not shown in the Dataform UI.

pub fn get_repository(&self) -> GetRepository

Fetches a single Repository.

pub fn create_repository(&self) -> CreateRepository

Creates a new Repository in a given project and location.

pub fn update_repository(&self) -> UpdateRepository

Updates a single Repository.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

pub fn delete_repository(&self) -> DeleteRepository

Deletes a single Repository.

pub fn commit_repository_changes(&self) -> CommitRepositoryChanges

Applies a Git commit to a Repository. The Repository must not have a value for git_remote_settings.url.

pub fn read_repository_file(&self) -> ReadRepositoryFile

Returns the contents of a file (inside a Repository). The Repository must not have a value for git_remote_settings.url.

pub fn query_repository_directory_contents( &self, ) -> QueryRepositoryDirectoryContents

Returns the contents of a given Repository directory. The Repository must not have a value for git_remote_settings.url.

pub fn fetch_repository_history(&self) -> FetchRepositoryHistory

Fetches a Repository’s history of commits. The Repository must not have a value for git_remote_settings.url.

pub fn compute_repository_access_token_status( &self, ) -> ComputeRepositoryAccessTokenStatus

Computes a Repository’s Git access token status.

pub fn fetch_remote_branches(&self) -> FetchRemoteBranches

Fetches a Repository’s remote branches.

pub fn list_workspaces(&self) -> ListWorkspaces

Lists Workspaces in a given Repository.

pub fn get_workspace(&self) -> GetWorkspace

Fetches a single Workspace.

pub fn create_workspace(&self) -> CreateWorkspace

Creates a new Workspace in a given Repository.

pub fn delete_workspace(&self) -> DeleteWorkspace

Deletes a single Workspace.

pub fn install_npm_packages(&self) -> InstallNpmPackages

Installs dependency NPM packages (inside a Workspace).

pub fn pull_git_commits(&self) -> PullGitCommits

Pulls Git commits from the Repository’s remote into a Workspace.

pub fn push_git_commits(&self) -> PushGitCommits

Pushes Git commits from a Workspace to the Repository’s remote.

pub fn fetch_file_git_statuses(&self) -> FetchFileGitStatuses

Fetches Git statuses for the files in a Workspace.

pub fn fetch_git_ahead_behind(&self) -> FetchGitAheadBehind

Fetches Git ahead/behind against a remote branch.

pub fn commit_workspace_changes(&self) -> CommitWorkspaceChanges

Applies a Git commit for uncommitted files in a Workspace.

pub fn reset_workspace_changes(&self) -> ResetWorkspaceChanges

Performs a Git reset for uncommitted files in a Workspace.

pub fn fetch_file_diff(&self) -> FetchFileDiff

Fetches Git diff for an uncommitted file in a Workspace.

pub fn query_directory_contents(&self) -> QueryDirectoryContents

Returns the contents of a given Workspace directory.

pub fn search_files(&self) -> SearchFiles

Finds the contents of a given Workspace directory by filter.

pub fn make_directory(&self) -> MakeDirectory

Creates a directory inside a Workspace.

pub fn remove_directory(&self) -> RemoveDirectory

Deletes a directory (inside a Workspace) and all of its contents.

pub fn move_directory(&self) -> MoveDirectory

Moves a directory (inside a Workspace), and all of its contents, to a new location.

pub fn read_file(&self) -> ReadFile

Returns the contents of a file (inside a Workspace).

pub fn remove_file(&self) -> RemoveFile

Deletes a file (inside a Workspace).

pub fn move_file(&self) -> MoveFile

Moves a file (inside a Workspace) to a new location.

pub fn write_file(&self) -> WriteFile

Writes to a file (inside a Workspace).

pub fn list_release_configs(&self) -> ListReleaseConfigs

Lists ReleaseConfigs in a given Repository.

pub fn get_release_config(&self) -> GetReleaseConfig

Fetches a single ReleaseConfig.

pub fn create_release_config(&self) -> CreateReleaseConfig

Creates a new ReleaseConfig in a given Repository.

pub fn update_release_config(&self) -> UpdateReleaseConfig

Updates a single ReleaseConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

pub fn delete_release_config(&self) -> DeleteReleaseConfig

Deletes a single ReleaseConfig.

pub fn list_compilation_results(&self) -> ListCompilationResults

Lists CompilationResults in a given Repository.

pub fn get_compilation_result(&self) -> GetCompilationResult

Fetches a single CompilationResult.

pub fn create_compilation_result(&self) -> CreateCompilationResult

Creates a new CompilationResult in a given project and location.

pub fn query_compilation_result_actions(&self) -> QueryCompilationResultActions

Returns CompilationResultActions in a given CompilationResult.

pub fn list_workflow_configs(&self) -> ListWorkflowConfigs

Lists WorkflowConfigs in a given Repository.

pub fn get_workflow_config(&self) -> GetWorkflowConfig

Fetches a single WorkflowConfig.

pub fn create_workflow_config(&self) -> CreateWorkflowConfig

Creates a new WorkflowConfig in a given Repository.

pub fn update_workflow_config(&self) -> UpdateWorkflowConfig

Updates a single WorkflowConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

pub fn delete_workflow_config(&self) -> DeleteWorkflowConfig

Deletes a single WorkflowConfig.

pub fn list_workflow_invocations(&self) -> ListWorkflowInvocations

Lists WorkflowInvocations in a given Repository.

pub fn get_workflow_invocation(&self) -> GetWorkflowInvocation

Fetches a single WorkflowInvocation.

pub fn create_workflow_invocation(&self) -> CreateWorkflowInvocation

Creates a new WorkflowInvocation in a given Repository.

pub fn delete_workflow_invocation(&self) -> DeleteWorkflowInvocation

Deletes a single WorkflowInvocation.

pub fn cancel_workflow_invocation(&self) -> CancelWorkflowInvocation

Requests cancellation of a running WorkflowInvocation.

pub fn query_workflow_invocation_actions( &self, ) -> QueryWorkflowInvocationActions

Returns WorkflowInvocationActions in a given WorkflowInvocation.

pub fn get_config(&self) -> GetConfig

Get default config for a given project and location.

pub fn update_config(&self) -> UpdateConfig

Update default config for a given project and location.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

Trait Implementations

impl Clone for Dataform

fn clone(&self) -> Dataform

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Dataform

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.