Dataform V1beta1 API - Class Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client (v0.3.0)

Reference documentation and code samples for the Dataform V1beta1 API class Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.

REST client for the Dataform service.

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

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Dataform Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Dataform clients
::Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#cancel_workflow_invocation

def cancel_workflow_invocation(request, options = nil) -> ::Google::Protobuf::Empty
def cancel_workflow_invocation(name: nil) -> ::Google::Protobuf::Empty

Requests cancellation of a running WorkflowInvocation.

Overloads 
def cancel_workflow_invocation(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel_workflow_invocation via a request object, either of type CancelWorkflowInvocationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def cancel_workflow_invocation(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel_workflow_invocation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The workflow invocation resource's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#commit_workspace_changes

def commit_workspace_changes(request, options = nil) -> ::Google::Protobuf::Empty
def commit_workspace_changes(name: nil, author: nil, commit_message: nil, paths: nil) -> ::Google::Protobuf::Empty

Applies a Git commit for uncommitted files in a Workspace.

Overloads 
def commit_workspace_changes(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to commit_workspace_changes via a request object, either of type CommitWorkspaceChangesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def commit_workspace_changes(name: nil, author: nil, commit_message: nil, paths: nil) -> ::Google::Protobuf::Empty
Pass arguments to commit_workspace_changes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The workspace's name.
  • author (::Google::Cloud::Dataform::V1beta1::CommitAuthor, ::Hash) — Required. The commit's author.
  • commit_message (::String) — Optional. The commit's message.
  • paths (::Array<::String>) — Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Dataform Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_compilation_result

def create_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
def create_compilation_result(parent: nil, compilation_result: nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult

Creates a new CompilationResult in a given project and location.

Overloads 
def create_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
Pass arguments to create_compilation_result via a request object, either of type CreateCompilationResultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::CreateCompilationResultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_compilation_result(parent: nil, compilation_result: nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
Pass arguments to create_compilation_result via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The repository in which to create the compilation result. Must be in the format projects/*/locations/*/repositories/*.
  • compilation_result (::Google::Cloud::Dataform::V1beta1::CompilationResult, ::Hash) — Required. The compilation result to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#create_repository

def create_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
def create_repository(parent: nil, repository: nil, repository_id: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository

Creates a new Repository in a given project and location.

Overloads 
def create_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Pass arguments to create_repository via a request object, either of type CreateRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::CreateRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_repository(parent: nil, repository: nil, repository_id: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Pass arguments to create_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The location in which to create the repository. Must be in the format projects/*/locations/*.
  • repository (::Google::Cloud::Dataform::V1beta1::Repository, ::Hash) — Required. The repository to create.
  • repository_id (::String) — Required. The ID to use for the repository, which will become the final component of the repository's resource name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#create_workflow_invocation

def create_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
def create_workflow_invocation(parent: nil, workflow_invocation: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

Creates a new WorkflowInvocation in a given Repository.

Overloads 
def create_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
Pass arguments to create_workflow_invocation via a request object, either of type CreateWorkflowInvocationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::CreateWorkflowInvocationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_workflow_invocation(parent: nil, workflow_invocation: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
Pass arguments to create_workflow_invocation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The repository in which to create the workflow invocation. Must be in the format projects/*/locations/*/repositories/*.
  • workflow_invocation (::Google::Cloud::Dataform::V1beta1::WorkflowInvocation, ::Hash) — Required. The workflow invocation resource to create.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#create_workspace

def create_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
def create_workspace(parent: nil, workspace: nil, workspace_id: nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace

Creates a new Workspace in a given Repository.

Overloads 
def create_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
Pass arguments to create_workspace via a request object, either of type CreateWorkspaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::CreateWorkspaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_workspace(parent: nil, workspace: nil, workspace_id: nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
Pass arguments to create_workspace via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The repository in which to create the workspace. Must be in the format projects/*/locations/*/repositories/*.
  • workspace (::Google::Cloud::Dataform::V1beta1::Workspace, ::Hash) — Required. The workspace to create.
  • workspace_id (::String) — Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_repository

def delete_repository(request, options = nil) -> ::Google::Protobuf::Empty
def delete_repository(name: nil, force: nil) -> ::Google::Protobuf::Empty

Deletes a single Repository.

Overloads 
def delete_repository(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_repository via a request object, either of type Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_repository(name: nil, force: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The repository's name.
  • force (::Boolean) — If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_workflow_invocation

def delete_workflow_invocation(request, options = nil) -> ::Google::Protobuf::Empty
def delete_workflow_invocation(name: nil) -> ::Google::Protobuf::Empty

Deletes a single WorkflowInvocation.

Overloads 
def delete_workflow_invocation(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_workflow_invocation via a request object, either of type Google::Cloud::Dataform::V1beta1::DeleteWorkflowInvocationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::DeleteWorkflowInvocationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_workflow_invocation(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_workflow_invocation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The workflow invocation resource's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#delete_workspace

def delete_workspace(request, options = nil) -> ::Google::Protobuf::Empty
def delete_workspace(name: nil) -> ::Google::Protobuf::Empty

Deletes a single Workspace.

Overloads 
def delete_workspace(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_workspace via a request object, either of type Google::Cloud::Dataform::V1beta1::DeleteWorkspaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::DeleteWorkspaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_workspace(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_workspace via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The workspace resource's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#fetch_file_diff

def fetch_file_diff(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse
def fetch_file_diff(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse

Fetches Git diff for an uncommitted file in a Workspace.

Overloads 
def fetch_file_diff(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse
Pass arguments to fetch_file_diff via a request object, either of type FetchFileDiffRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::FetchFileDiffRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def fetch_file_diff(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse
Pass arguments to fetch_file_diff via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Required. The file's full path including filename, relative to the workspace root.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#fetch_file_git_statuses

def fetch_file_git_statuses(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse
def fetch_file_git_statuses(name: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse

Fetches Git statuses for the files in a Workspace.

Overloads 
def fetch_file_git_statuses(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse
Pass arguments to fetch_file_git_statuses via a request object, either of type FetchFileGitStatusesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def fetch_file_git_statuses(name: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse
Pass arguments to fetch_file_git_statuses via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The workspace's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#fetch_git_ahead_behind

def fetch_git_ahead_behind(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse
def fetch_git_ahead_behind(name: nil, remote_branch: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse

Fetches Git ahead/behind against a remote branch.

Overloads 
def fetch_git_ahead_behind(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse
Pass arguments to fetch_git_ahead_behind via a request object, either of type FetchGitAheadBehindRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def fetch_git_ahead_behind(name: nil, remote_branch: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse
Pass arguments to fetch_git_ahead_behind via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The workspace's name.
  • remote_branch (::String) — Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#fetch_remote_branches

def fetch_remote_branches(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse
def fetch_remote_branches(name: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse

Fetches a Repository's remote branches.

Overloads 
def fetch_remote_branches(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse
Pass arguments to fetch_remote_branches via a request object, either of type FetchRemoteBranchesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def fetch_remote_branches(name: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse
Pass arguments to fetch_remote_branches via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The repository's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_compilation_result

def get_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
def get_compilation_result(name: nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult

Fetches a single CompilationResult.

Overloads 
def get_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
Pass arguments to get_compilation_result via a request object, either of type GetCompilationResultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::GetCompilationResultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_compilation_result(name: nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
Pass arguments to get_compilation_result via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The compilation result's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_repository

def get_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
def get_repository(name: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository

Fetches a single Repository.

Overloads 
def get_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Pass arguments to get_repository via a request object, either of type GetRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::GetRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_repository(name: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Pass arguments to get_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The repository's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_workflow_invocation

def get_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
def get_workflow_invocation(name: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

Fetches a single WorkflowInvocation.

Overloads 
def get_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
Pass arguments to get_workflow_invocation via a request object, either of type GetWorkflowInvocationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::GetWorkflowInvocationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_workflow_invocation(name: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
Pass arguments to get_workflow_invocation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The workflow invocation resource's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#get_workspace

def get_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
def get_workspace(name: nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace

Fetches a single Workspace.

Overloads 
def get_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
Pass arguments to get_workspace via a request object, either of type GetWorkspaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::GetWorkspaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_workspace(name: nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
Pass arguments to get_workspace via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The workspace's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

Get the associated client for mix-in of the IAMPolicy.

Returns
  • (Google::Iam::V1::IAMPolicy::Rest::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new Dataform REST client object.

Yields
  • (config) — Configure the Dataform client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new do |config|
  config.timeout = 10.0
end

#install_npm_packages

def install_npm_packages(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse
def install_npm_packages(workspace: nil) -> ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse

Installs dependency NPM packages (inside a Workspace).

Overloads 
def install_npm_packages(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse
Pass arguments to install_npm_packages via a request object, either of type InstallNpmPackagesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def install_npm_packages(workspace: nil) -> ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse
Pass arguments to install_npm_packages via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • workspace (::String) — Required. The workspace's name.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_compilation_results

def list_compilation_results(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse
def list_compilation_results(parent: nil, page_size: nil, page_token: nil) -> ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse

Lists CompilationResults in a given Repository.

Overloads 
def list_compilation_results(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse
Pass arguments to list_compilation_results via a request object, either of type ListCompilationResultsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::ListCompilationResultsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_compilation_results(parent: nil, page_size: nil, page_token: nil) -> ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse
Pass arguments to list_compilation_results via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The repository in which to list compilation results. Must be in the format projects/*/locations/*/repositories/*.
  • page_size (::Integer) — Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  • page_token (::String) — Optional. Page token received from a previous ListCompilationResults call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListCompilationResults must match the call that provided the page token.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_repositories

def list_repositories(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse
def list_repositories(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse

Lists Repositories in a given project and location.

Overloads 
def list_repositories(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse
Pass arguments to list_repositories via a request object, either of type ListRepositoriesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::ListRepositoriesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_repositories(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse
Pass arguments to list_repositories via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The location in which to list repositories. Must be in the format projects/*/locations/*.
  • page_size (::Integer) — Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  • page_token (::String) — Optional. Page token received from a previous ListRepositories call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListRepositories must match the call that provided the page token.

  • order_by (::String) — Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.
  • filter (::String) — Optional. Filter for the returned list.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_workflow_invocations

def list_workflow_invocations(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse
def list_workflow_invocations(parent: nil, page_size: nil, page_token: nil) -> ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse

Lists WorkflowInvocations in a given Repository.

Overloads 
def list_workflow_invocations(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse
Pass arguments to list_workflow_invocations via a request object, either of type ListWorkflowInvocationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_workflow_invocations(parent: nil, page_size: nil, page_token: nil) -> ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse
Pass arguments to list_workflow_invocations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.
  • page_size (::Integer) — Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  • page_token (::String) — Optional. Page token received from a previous ListWorkflowInvocations call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListWorkflowInvocations must match the call that provided the page token.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#list_workspaces

def list_workspaces(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse
def list_workspaces(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse

Lists Workspaces in a given Repository.

Overloads 
def list_workspaces(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse
Pass arguments to list_workspaces via a request object, either of type ListWorkspacesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::ListWorkspacesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_workspaces(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse
Pass arguments to list_workspaces via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.
  • page_size (::Integer) — Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  • page_token (::String) — Optional. Page token received from a previous ListWorkspaces call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListWorkspaces must match the call that provided the page token.

  • order_by (::String) — Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.
  • filter (::String) — Optional. Filter for the returned list.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Rest::Client)

#make_directory

def make_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse
def make_directory(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse

Creates a directory inside a Workspace.

Overloads 
def make_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse
Pass arguments to make_directory via a request object, either of type MakeDirectoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::MakeDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def make_directory(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse
Pass arguments to make_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Required. The directory's full path including directory name, relative to the workspace root.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#move_directory

def move_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse
def move_directory(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse

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

Overloads 
def move_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse
Pass arguments to move_directory via a request object, either of type MoveDirectoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::MoveDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def move_directory(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse
Pass arguments to move_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Required. The directory's full path including directory name, relative to the workspace root.
  • new_path (::String) — Required. The new path for the directory including directory name, rooted at workspace root.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#move_file

def move_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MoveFileResponse
def move_file(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1beta1::MoveFileResponse

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

Overloads 
def move_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MoveFileResponse
Pass arguments to move_file via a request object, either of type MoveFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::MoveFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def move_file(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1beta1::MoveFileResponse
Pass arguments to move_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Required. The file's full path including filename, relative to the workspace root.
  • new_path (::String) — Required. The file's new path including filename, relative to the workspace root.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#pull_git_commits

def pull_git_commits(request, options = nil) -> ::Google::Protobuf::Empty
def pull_git_commits(name: nil, remote_branch: nil, author: nil) -> ::Google::Protobuf::Empty

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

Overloads 
def pull_git_commits(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to pull_git_commits via a request object, either of type PullGitCommitsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::PullGitCommitsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def pull_git_commits(name: nil, remote_branch: nil, author: nil) -> ::Google::Protobuf::Empty
Pass arguments to pull_git_commits via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The workspace's name.
  • remote_branch (::String) — Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.
  • author (::Google::Cloud::Dataform::V1beta1::CommitAuthor, ::Hash) — Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#push_git_commits

def push_git_commits(request, options = nil) -> ::Google::Protobuf::Empty
def push_git_commits(name: nil, remote_branch: nil) -> ::Google::Protobuf::Empty

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

Overloads 
def push_git_commits(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to push_git_commits via a request object, either of type PushGitCommitsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::PushGitCommitsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def push_git_commits(name: nil, remote_branch: nil) -> ::Google::Protobuf::Empty
Pass arguments to push_git_commits via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The workspace's name.
  • remote_branch (::String) — Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#query_compilation_result_actions

def query_compilation_result_actions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>
def query_compilation_result_actions(name: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>

Returns CompilationResultActions in a given CompilationResult.

Overloads 
def query_compilation_result_actions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>
Pass arguments to query_compilation_result_actions via a request object, either of type QueryCompilationResultActionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::QueryCompilationResultActionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def query_compilation_result_actions(name: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>
Pass arguments to query_compilation_result_actions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The compilation result's name.
  • page_size (::Integer) — Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  • page_token (::String) — Optional. Page token received from a previous QueryCompilationResultActions call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryCompilationResultActions must match the call that provided the page token.

  • filter (::String) — Optional. Optional filter for the returned list. Filtering is only currently supported on the file_path field.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#query_directory_contents

def query_directory_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsResponse::DirectoryEntry>
def query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsResponse::DirectoryEntry>

Returns the contents of a given Workspace directory.

Overloads 
def query_directory_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsResponse::DirectoryEntry>
Pass arguments to query_directory_contents via a request object, either of type QueryDirectoryContentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsResponse::DirectoryEntry>
Pass arguments to query_directory_contents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
  • page_size (::Integer) — Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  • page_token (::String) — Optional. Page token received from a previous QueryDirectoryContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryDirectoryContents must match the call that provided the page token.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#query_workflow_invocation_actions

def query_workflow_invocation_actions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>
def query_workflow_invocation_actions(name: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Overloads 
def query_workflow_invocation_actions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>
Pass arguments to query_workflow_invocation_actions via a request object, either of type QueryWorkflowInvocationActionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::QueryWorkflowInvocationActionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def query_workflow_invocation_actions(name: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>
Pass arguments to query_workflow_invocation_actions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The workflow invocation's name.
  • page_size (::Integer) — Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  • page_token (::String) — Optional. Page token received from a previous QueryWorkflowInvocationActions call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryWorkflowInvocationActions must match the call that provided the page token.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#read_file

def read_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReadFileResponse
def read_file(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::ReadFileResponse

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

Overloads 
def read_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReadFileResponse
Pass arguments to read_file via a request object, either of type ReadFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::ReadFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def read_file(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::ReadFileResponse
Pass arguments to read_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Required. The file's full path including filename, relative to the workspace root.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#remove_directory

def remove_directory(request, options = nil) -> ::Google::Protobuf::Empty
def remove_directory(workspace: nil, path: nil) -> ::Google::Protobuf::Empty

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

Overloads 
def remove_directory(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to remove_directory via a request object, either of type RemoveDirectoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def remove_directory(workspace: nil, path: nil) -> ::Google::Protobuf::Empty
Pass arguments to remove_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Required. The directory's full path including directory name, relative to the workspace root.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#remove_file

def remove_file(request, options = nil) -> ::Google::Protobuf::Empty
def remove_file(workspace: nil, path: nil) -> ::Google::Protobuf::Empty

Deletes a file (inside a Workspace).

Overloads 
def remove_file(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to remove_file via a request object, either of type RemoveFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::RemoveFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def remove_file(workspace: nil, path: nil) -> ::Google::Protobuf::Empty
Pass arguments to remove_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Required. The file's full path including filename, relative to the workspace root.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#reset_workspace_changes

def reset_workspace_changes(request, options = nil) -> ::Google::Protobuf::Empty
def reset_workspace_changes(name: nil, paths: nil, clean: nil) -> ::Google::Protobuf::Empty

Performs a Git reset for uncommitted files in a Workspace.

Overloads 
def reset_workspace_changes(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to reset_workspace_changes via a request object, either of type ResetWorkspaceChangesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def reset_workspace_changes(name: nil, paths: nil, clean: nil) -> ::Google::Protobuf::Empty
Pass arguments to reset_workspace_changes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The workspace's name.
  • paths (::Array<::String>) — Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset.
  • clean (::Boolean) — Optional. If set to true, untracked files will be deleted.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#update_repository

def update_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
def update_repository(update_mask: nil, repository: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository

Updates a single Repository.

Overloads 
def update_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Pass arguments to update_repository via a request object, either of type UpdateRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_repository(update_mask: nil, repository: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Pass arguments to update_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.

#write_file

def write_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WriteFileResponse
def write_file(workspace: nil, path: nil, contents: nil) -> ::Google::Cloud::Dataform::V1beta1::WriteFileResponse

Writes to a file (inside a Workspace).

Overloads 
def write_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WriteFileResponse
Pass arguments to write_file via a request object, either of type WriteFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1beta1::WriteFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def write_file(workspace: nil, path: nil, contents: nil) -> ::Google::Cloud::Dataform::V1beta1::WriteFileResponse
Pass arguments to write_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • workspace (::String) — Required. The workspace's name.
  • path (::String) — Required. The file.
  • contents (::String) — Required. The file's contents.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.