Dataform V1 API - Class Google::Cloud::Dataform::V1::Dataform::Rest::Client (v0.4.0)

Reference documentation and code samples for the Dataform V1 API class Google::Cloud::Dataform::V1::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::V1::Dataform::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#cancel_workflow_invocation

def cancel_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1::CancelWorkflowInvocationResponse
def cancel_workflow_invocation(name: nil) -> ::Google::Cloud::Dataform::V1::CancelWorkflowInvocationResponse

Requests cancellation of a running WorkflowInvocation.

Overloads 
def cancel_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1::CancelWorkflowInvocationResponse
Pass arguments to cancel_workflow_invocation via a request object, either of type CancelWorkflowInvocationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::Cloud::Dataform::V1::CancelWorkflowInvocationResponse
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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CancelWorkflowInvocationRequest.new

# Call the cancel_workflow_invocation method.
result = client.cancel_workflow_invocation request

# The returned object is of type Google::Cloud::Dataform::V1::CancelWorkflowInvocationResponse.
p result

#commit_repository_changes

def commit_repository_changes(request, options = nil) -> ::Google::Cloud::Dataform::V1::CommitRepositoryChangesResponse
def commit_repository_changes(name: nil, commit_metadata: nil, required_head_commit_sha: nil, file_operations: nil) -> ::Google::Cloud::Dataform::V1::CommitRepositoryChangesResponse

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

Overloads 
def commit_repository_changes(request, options = nil) -> ::Google::Cloud::Dataform::V1::CommitRepositoryChangesResponse
Pass arguments to commit_repository_changes via a request object, either of type CommitRepositoryChangesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::CommitRepositoryChangesRequest, ::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_repository_changes(name: nil, commit_metadata: nil, required_head_commit_sha: nil, file_operations: nil) -> ::Google::Cloud::Dataform::V1::CommitRepositoryChangesResponse
Pass arguments to commit_repository_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 repository's name.
  • commit_metadata (::Google::Cloud::Dataform::V1::CommitMetadata, ::Hash) — Required. The changes to commit to the repository.
  • required_head_commit_sha (::String) — Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed.
  • file_operations (::Hash{::String => ::Google::Cloud::Dataform::V1::CommitRepositoryChangesRequest::FileOperation, ::Hash}) — Optional. A map to the path of the file to the operation. The path is the full file path including filename, from repository 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CommitRepositoryChangesRequest.new

# Call the commit_repository_changes method.
result = client.commit_repository_changes request

# The returned object is of type Google::Cloud::Dataform::V1::CommitRepositoryChangesResponse.
p result

#commit_workspace_changes

def commit_workspace_changes(request, options = nil) -> ::Google::Cloud::Dataform::V1::CommitWorkspaceChangesResponse
def commit_workspace_changes(name: nil, author: nil, commit_message: nil, paths: nil) -> ::Google::Cloud::Dataform::V1::CommitWorkspaceChangesResponse

Applies a Git commit for uncommitted files in a Workspace.

Overloads 
def commit_workspace_changes(request, options = nil) -> ::Google::Cloud::Dataform::V1::CommitWorkspaceChangesResponse
Pass arguments to commit_workspace_changes via a request object, either of type CommitWorkspaceChangesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::Cloud::Dataform::V1::CommitWorkspaceChangesResponse
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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CommitWorkspaceChangesRequest.new

# Call the commit_workspace_changes method.
result = client.commit_workspace_changes request

# The returned object is of type Google::Cloud::Dataform::V1::CommitWorkspaceChangesResponse.
p result

#compute_repository_access_token_status

def compute_repository_access_token_status(request, options = nil) -> ::Google::Cloud::Dataform::V1::ComputeRepositoryAccessTokenStatusResponse
def compute_repository_access_token_status(name: nil) -> ::Google::Cloud::Dataform::V1::ComputeRepositoryAccessTokenStatusResponse

Computes a Repository's Git access token status.

Overloads 
def compute_repository_access_token_status(request, options = nil) -> ::Google::Cloud::Dataform::V1::ComputeRepositoryAccessTokenStatusResponse
Pass arguments to compute_repository_access_token_status via a request object, either of type ComputeRepositoryAccessTokenStatusRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::ComputeRepositoryAccessTokenStatusRequest, ::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 compute_repository_access_token_status(name: nil) -> ::Google::Cloud::Dataform::V1::ComputeRepositoryAccessTokenStatusResponse
Pass arguments to compute_repository_access_token_status 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ComputeRepositoryAccessTokenStatusRequest.new

# Call the compute_repository_access_token_status method.
result = client.compute_repository_access_token_status request

# The returned object is of type Google::Cloud::Dataform::V1::ComputeRepositoryAccessTokenStatusResponse.
p result

#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::V1::CompilationResult
def create_compilation_result(parent: nil, compilation_result: nil) -> ::Google::Cloud::Dataform::V1::CompilationResult

Creates a new CompilationResult in a given project and location.

Overloads 
def create_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1::CompilationResult
Pass arguments to create_compilation_result via a request object, either of type CreateCompilationResultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CreateCompilationResultRequest.new

# Call the create_compilation_result method.
result = client.create_compilation_result request

# The returned object is of type Google::Cloud::Dataform::V1::CompilationResult.
p result

#create_folder

def create_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::Folder
def create_folder(parent: nil, folder: nil) -> ::Google::Cloud::Dataform::V1::Folder

Creates a new Folder in a given project and location.

Overloads 
def create_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::Folder
Pass arguments to create_folder via a request object, either of type CreateFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::CreateFolderRequest, ::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_folder(parent: nil, folder: nil) -> ::Google::Cloud::Dataform::V1::Folder
Pass arguments to create_folder 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 Folder. Must be in the format projects/*/locations/*.
  • folder (::Google::Cloud::Dataform::V1::Folder, ::Hash) — Required. The Folder 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CreateFolderRequest.new

# Call the create_folder method.
result = client.create_folder request

# The returned object is of type Google::Cloud::Dataform::V1::Folder.
p result

#create_release_config

def create_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
def create_release_config(parent: nil, release_config: nil, release_config_id: nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig

Creates a new ReleaseConfig in a given Repository.

Overloads 
def create_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
Pass arguments to create_release_config via a request object, either of type CreateReleaseConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::CreateReleaseConfigRequest, ::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_release_config(parent: nil, release_config: nil, release_config_id: nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
Pass arguments to create_release_config 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 release config. Must be in the format projects/*/locations/*/repositories/*.
  • release_config (::Google::Cloud::Dataform::V1::ReleaseConfig, ::Hash) — Required. The release config to create.
  • release_config_id (::String) — Required. The ID to use for the release config, which will become the final component of the release config'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CreateReleaseConfigRequest.new

# Call the create_release_config method.
result = client.create_release_config request

# The returned object is of type Google::Cloud::Dataform::V1::ReleaseConfig.
p result

#create_repository

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

Creates a new Repository in a given project and location.

Overloads 
def create_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1::Repository
Pass arguments to create_repository via a request object, either of type CreateRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CreateRepositoryRequest.new

# Call the create_repository method.
result = client.create_repository request

# The returned object is of type Google::Cloud::Dataform::V1::Repository.
p result

#create_team_folder

def create_team_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
def create_team_folder(parent: nil, team_folder: nil) -> ::Google::Cloud::Dataform::V1::TeamFolder

Creates a new TeamFolder in a given project and location.

Overloads 
def create_team_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
Pass arguments to create_team_folder via a request object, either of type CreateTeamFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::CreateTeamFolderRequest, ::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_team_folder(parent: nil, team_folder: nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
Pass arguments to create_team_folder 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 TeamFolder. Must be in the format projects/*/locations/*.
  • team_folder (::Google::Cloud::Dataform::V1::TeamFolder, ::Hash) — Required. The TeamFolder 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CreateTeamFolderRequest.new

# Call the create_team_folder method.
result = client.create_team_folder request

# The returned object is of type Google::Cloud::Dataform::V1::TeamFolder.
p result

#create_workflow_config

def create_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
def create_workflow_config(parent: nil, workflow_config: nil, workflow_config_id: nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig

Creates a new WorkflowConfig in a given Repository.

Overloads 
def create_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
Pass arguments to create_workflow_config via a request object, either of type CreateWorkflowConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::CreateWorkflowConfigRequest, ::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_config(parent: nil, workflow_config: nil, workflow_config_id: nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
Pass arguments to create_workflow_config 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 config. Must be in the format projects/*/locations/*/repositories/*.
  • workflow_config (::Google::Cloud::Dataform::V1::WorkflowConfig, ::Hash) — Required. The workflow config to create.
  • workflow_config_id (::String) — Required. The ID to use for the workflow config, which will become the final component of the workflow config'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CreateWorkflowConfigRequest.new

# Call the create_workflow_config method.
result = client.create_workflow_config request

# The returned object is of type Google::Cloud::Dataform::V1::WorkflowConfig.
p result

#create_workflow_invocation

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

Creates a new WorkflowInvocation in a given Repository.

Overloads 
def create_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1::WorkflowInvocation
Pass arguments to create_workflow_invocation via a request object, either of type CreateWorkflowInvocationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CreateWorkflowInvocationRequest.new

# Call the create_workflow_invocation method.
result = client.create_workflow_invocation request

# The returned object is of type Google::Cloud::Dataform::V1::WorkflowInvocation.
p result

#create_workspace

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

Creates a new Workspace in a given Repository.

Overloads 
def create_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1::Workspace
Pass arguments to create_workspace via a request object, either of type CreateWorkspaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::CreateWorkspaceRequest.new

# Call the create_workspace method.
result = client.create_workspace request

# The returned object is of type Google::Cloud::Dataform::V1::Workspace.
p result

#delete_folder

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

Deletes a single Folder.

Overloads 
def delete_folder(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_folder via a request object, either of type Google::Cloud::Dataform::V1::DeleteFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::DeleteFolderRequest, ::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_folder(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_folder 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 Folder'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteFolderRequest.new

# Call the delete_folder method.
result = client.delete_folder request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_folder_tree

def delete_folder_tree(request, options = nil) -> ::Gapic::Operation
def delete_folder_tree(name: nil, force: nil) -> ::Gapic::Operation

Deletes a Folder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Overloads 
def delete_folder_tree(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_folder_tree via a request object, either of type Google::Cloud::Dataform::V1::DeleteFolderTreeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::DeleteFolderTreeRequest, ::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_folder_tree(name: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_folder_tree 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 Folder's name. Format: projects/{project}/locations/{location}/folders/{folder}
  • force (::Boolean) — Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

    If true: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.

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

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteFolderTreeRequest.new

# Call the delete_folder_tree method.
result = client.delete_folder_tree request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_release_config

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

Deletes a single ReleaseConfig.

Overloads 
def delete_release_config(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_release_config via a request object, either of type Google::Cloud::Dataform::V1::DeleteReleaseConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::DeleteReleaseConfigRequest, ::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_release_config(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_release_config 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 release config'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteReleaseConfigRequest.new

# Call the delete_release_config method.
result = client.delete_release_config request

# The returned object is of type Google::Protobuf::Empty.
p result

#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::V1::DeleteRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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) — Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources.

    Note: This flag doesn't support deletion of workspaces, release configs or workflow configs. If any of such resources exists in the repository, the request will fail..

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

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteRepositoryRequest.new

# Call the delete_repository method.
result = client.delete_repository request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_team_folder

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

Deletes a single TeamFolder.

Overloads 
def delete_team_folder(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_team_folder via a request object, either of type Google::Cloud::Dataform::V1::DeleteTeamFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::DeleteTeamFolderRequest, ::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_team_folder(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_team_folder 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 TeamFolder'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteTeamFolderRequest.new

# Call the delete_team_folder method.
result = client.delete_team_folder request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_team_folder_tree

def delete_team_folder_tree(request, options = nil) -> ::Gapic::Operation
def delete_team_folder_tree(name: nil, force: nil) -> ::Gapic::Operation

Deletes a TeamFolder with its contents (Folders, Repositories, Workspaces, ReleaseConfigs, and WorkflowConfigs).

Overloads 
def delete_team_folder_tree(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_team_folder_tree via a request object, either of type Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest, ::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_team_folder_tree(name: nil, force: nil) -> ::Gapic::Operation
Pass arguments to delete_team_folder_tree 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 TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder}
  • force (::Boolean) — Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

    If true: The operation will attempt to delete everything, including any Release Configs and Workflow Configs linked to Repositories within the folder hierarchy. This permanently removes schedules and resources.

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

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest.new

# Call the delete_team_folder_tree method.
result = client.delete_team_folder_tree request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_workflow_config

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

Deletes a single WorkflowConfig.

Overloads 
def delete_workflow_config(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_workflow_config via a request object, either of type Google::Cloud::Dataform::V1::DeleteWorkflowConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::DeleteWorkflowConfigRequest, ::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_config(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_workflow_config 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 config'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteWorkflowConfigRequest.new

# Call the delete_workflow_config method.
result = client.delete_workflow_config request

# The returned object is of type Google::Protobuf::Empty.
p result

#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::V1::DeleteWorkflowInvocationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteWorkflowInvocationRequest.new

# Call the delete_workflow_invocation method.
result = client.delete_workflow_invocation request

# The returned object is of type Google::Protobuf::Empty.
p result

#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::V1::DeleteWorkspaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::DeleteWorkspaceRequest.new

# Call the delete_workspace method.
result = client.delete_workspace request

# The returned object is of type Google::Protobuf::Empty.
p result

#fetch_file_diff

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

Fetches Git diff for an uncommitted file in a Workspace.

Overloads 
def fetch_file_diff(request, options = nil) -> ::Google::Cloud::Dataform::V1::FetchFileDiffResponse
Pass arguments to fetch_file_diff via a request object, either of type FetchFileDiffRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::FetchFileDiffRequest.new

# Call the fetch_file_diff method.
result = client.fetch_file_diff request

# The returned object is of type Google::Cloud::Dataform::V1::FetchFileDiffResponse.
p result

#fetch_file_git_statuses

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

Fetches Git statuses for the files in a Workspace.

Overloads 
def fetch_file_git_statuses(request, options = nil) -> ::Google::Cloud::Dataform::V1::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::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::FetchFileGitStatusesRequest.new

# Call the fetch_file_git_statuses method.
result = client.fetch_file_git_statuses request

# The returned object is of type Google::Cloud::Dataform::V1::FetchFileGitStatusesResponse.
p result

#fetch_git_ahead_behind

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

Fetches Git ahead/behind against a remote branch.

Overloads 
def fetch_git_ahead_behind(request, options = nil) -> ::Google::Cloud::Dataform::V1::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::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::FetchGitAheadBehindRequest.new

# Call the fetch_git_ahead_behind method.
result = client.fetch_git_ahead_behind request

# The returned object is of type Google::Cloud::Dataform::V1::FetchGitAheadBehindResponse.
p result

#fetch_remote_branches

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

Fetches a Repository's remote branches.

Overloads 
def fetch_remote_branches(request, options = nil) -> ::Google::Cloud::Dataform::V1::FetchRemoteBranchesResponse
Pass arguments to fetch_remote_branches via a request object, either of type FetchRemoteBranchesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::FetchRemoteBranchesRequest.new

# Call the fetch_remote_branches method.
result = client.fetch_remote_branches request

# The returned object is of type Google::Cloud::Dataform::V1::FetchRemoteBranchesResponse.
p result

#fetch_repository_history

def fetch_repository_history(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CommitLogEntry>
def fetch_repository_history(name: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CommitLogEntry>

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

Overloads 
def fetch_repository_history(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CommitLogEntry>
Pass arguments to fetch_repository_history via a request object, either of type FetchRepositoryHistoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::FetchRepositoryHistoryRequest, ::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_repository_history(name: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CommitLogEntry>
Pass arguments to fetch_repository_history 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.
  • page_size (::Integer) — Optional. Maximum number of commits 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 FetchRepositoryHistory call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to FetchRepositoryHistory, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::FetchRepositoryHistoryRequest.new

# Call the fetch_repository_history method.
result = client.fetch_repository_history request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::CommitLogEntry.
  p item
end

#get_compilation_result

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

Fetches a single CompilationResult.

Overloads 
def get_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1::CompilationResult
Pass arguments to get_compilation_result via a request object, either of type GetCompilationResultRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetCompilationResultRequest.new

# Call the get_compilation_result method.
result = client.get_compilation_result request

# The returned object is of type Google::Cloud::Dataform::V1::CompilationResult.
p result

#get_config

def get_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::Config
def get_config(name: nil) -> ::Google::Cloud::Dataform::V1::Config

Get default config for a given project and location.

Overloads 
def get_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::Config
Pass arguments to get_config via a request object, either of type GetConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::GetConfigRequest, ::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_config(name: nil) -> ::Google::Cloud::Dataform::V1::Config
Pass arguments to get_config 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 config 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetConfigRequest.new

# Call the get_config method.
result = client.get_config request

# The returned object is of type Google::Cloud::Dataform::V1::Config.
p result

#get_folder

def get_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::Folder
def get_folder(name: nil) -> ::Google::Cloud::Dataform::V1::Folder

Fetches a single Folder.

Overloads 
def get_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::Folder
Pass arguments to get_folder via a request object, either of type GetFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::GetFolderRequest, ::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_folder(name: nil) -> ::Google::Cloud::Dataform::V1::Folder
Pass arguments to get_folder 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 Folder'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetFolderRequest.new

# Call the get_folder method.
result = client.get_folder request

# The returned object is of type Google::Cloud::Dataform::V1::Folder.
p result

#get_iam_policy

def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def get_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy

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

Overloads 
def get_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::GetIamPolicyRequest, ::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_iam_policy(resource: nil, options: nil) -> ::Google::Iam::V1::Policy
Pass arguments to get_iam_policy 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
  • resource (::String) — REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) — OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Google::Iam::V1::Policy)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Google::Iam::V1::Policy)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::GetIamPolicyRequest.new

# Call the get_iam_policy method.
result = client.get_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#get_release_config

def get_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
def get_release_config(name: nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig

Fetches a single ReleaseConfig.

Overloads 
def get_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
Pass arguments to get_release_config via a request object, either of type GetReleaseConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::GetReleaseConfigRequest, ::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_release_config(name: nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
Pass arguments to get_release_config 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 release config'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetReleaseConfigRequest.new

# Call the get_release_config method.
result = client.get_release_config request

# The returned object is of type Google::Cloud::Dataform::V1::ReleaseConfig.
p result

#get_repository

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

Fetches a single Repository.

Overloads 
def get_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1::Repository
Pass arguments to get_repository via a request object, either of type GetRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetRepositoryRequest.new

# Call the get_repository method.
result = client.get_repository request

# The returned object is of type Google::Cloud::Dataform::V1::Repository.
p result

#get_team_folder

def get_team_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
def get_team_folder(name: nil) -> ::Google::Cloud::Dataform::V1::TeamFolder

Fetches a single TeamFolder.

Overloads 
def get_team_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
Pass arguments to get_team_folder via a request object, either of type GetTeamFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::GetTeamFolderRequest, ::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_team_folder(name: nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
Pass arguments to get_team_folder 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 TeamFolder'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetTeamFolderRequest.new

# Call the get_team_folder method.
result = client.get_team_folder request

# The returned object is of type Google::Cloud::Dataform::V1::TeamFolder.
p result

#get_workflow_config

def get_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
def get_workflow_config(name: nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig

Fetches a single WorkflowConfig.

Overloads 
def get_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
Pass arguments to get_workflow_config via a request object, either of type GetWorkflowConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::GetWorkflowConfigRequest, ::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_config(name: nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
Pass arguments to get_workflow_config 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 config'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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetWorkflowConfigRequest.new

# Call the get_workflow_config method.
result = client.get_workflow_config request

# The returned object is of type Google::Cloud::Dataform::V1::WorkflowConfig.
p result

#get_workflow_invocation

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

Fetches a single WorkflowInvocation.

Overloads 
def get_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1::WorkflowInvocation
Pass arguments to get_workflow_invocation via a request object, either of type GetWorkflowInvocationRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetWorkflowInvocationRequest.new

# Call the get_workflow_invocation method.
result = client.get_workflow_invocation request

# The returned object is of type Google::Cloud::Dataform::V1::WorkflowInvocation.
p result

#get_workspace

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

Fetches a single Workspace.

Overloads 
def get_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1::Workspace
Pass arguments to get_workspace via a request object, either of type GetWorkspaceRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::GetWorkspaceRequest.new

# Call the get_workspace method.
result = client.get_workspace request

# The returned object is of type Google::Cloud::Dataform::V1::Workspace.
p result

#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::V1::Dataform::Rest::Client.new

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

#install_npm_packages

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

Installs dependency NPM packages (inside a Workspace).

Overloads 
def install_npm_packages(request, options = nil) -> ::Google::Cloud::Dataform::V1::InstallNpmPackagesResponse
Pass arguments to install_npm_packages via a request object, either of type InstallNpmPackagesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new

# Call the install_npm_packages method.
result = client.install_npm_packages request

# The returned object is of type Google::Cloud::Dataform::V1::InstallNpmPackagesResponse.
p result

#list_compilation_results

def list_compilation_results(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CompilationResult>
def list_compilation_results(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CompilationResult>

Lists CompilationResults in a given Repository.

Overloads 
def list_compilation_results(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CompilationResult>
Pass arguments to list_compilation_results via a request object, either of type ListCompilationResultsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CompilationResult>
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, with the exception of page_size, must match the call that provided the page token.

  • order_by (::String) — Optional. This field only supports ordering by name and create_time. 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ListCompilationResultsRequest.new

# Call the list_compilation_results method.
result = client.list_compilation_results request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::CompilationResult.
  p item
end

#list_release_configs

def list_release_configs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::ReleaseConfig>
def list_release_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::ReleaseConfig>

Lists ReleaseConfigs in a given Repository.

Overloads 
def list_release_configs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::ReleaseConfig>
Pass arguments to list_release_configs via a request object, either of type ListReleaseConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::ListReleaseConfigsRequest, ::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_release_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::ReleaseConfig>
Pass arguments to list_release_configs 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 release configs. Must be in the format projects/*/locations/*/repositories/*.
  • page_size (::Integer) — Optional. Maximum number of release configs 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 ListReleaseConfigs call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListReleaseConfigs, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ListReleaseConfigsRequest.new

# Call the list_release_configs method.
result = client.list_release_configs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::ReleaseConfig.
  p item
end

#list_repositories

def list_repositories(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Repository>
def list_repositories(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Repository>

Lists Repositories in a given project and location.

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

Overloads 
def list_repositories(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Repository>
Pass arguments to list_repositories via a request object, either of type ListRepositoriesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Repository>
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, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ListRepositoriesRequest.new

# Call the list_repositories method.
result = client.list_repositories request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::Repository.
  p item
end

#list_workflow_configs

def list_workflow_configs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowConfig>
def list_workflow_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowConfig>

Lists WorkflowConfigs in a given Repository.

Overloads 
def list_workflow_configs(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowConfig>
Pass arguments to list_workflow_configs via a request object, either of type ListWorkflowConfigsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::ListWorkflowConfigsRequest, ::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_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowConfig>
Pass arguments to list_workflow_configs 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 workflow configs. Must be in the format projects/*/locations/*/repositories/*.
  • page_size (::Integer) — Optional. Maximum number of workflow configs 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 ListWorkflowConfigs call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListWorkflowConfigs, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ListWorkflowConfigsRequest.new

# Call the list_workflow_configs method.
result = client.list_workflow_configs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::WorkflowConfig.
  p item
end

#list_workflow_invocations

def list_workflow_invocations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowInvocation>
def list_workflow_invocations(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowInvocation>

Lists WorkflowInvocations in a given Repository.

Overloads 
def list_workflow_invocations(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowInvocation>
Pass arguments to list_workflow_invocations via a request object, either of type ListWorkflowInvocationsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowInvocation>
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, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ListWorkflowInvocationsRequest.new

# Call the list_workflow_invocations method.
result = client.list_workflow_invocations request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::WorkflowInvocation.
  p item
end

#list_workspaces

def list_workspaces(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Workspace>
def list_workspaces(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Workspace>

Lists Workspaces in a given Repository.

Overloads 
def list_workspaces(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Workspace>
Pass arguments to list_workspaces via a request object, either of type ListWorkspacesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Workspace>
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, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ListWorkspacesRequest.new

# Call the list_workspaces method.
result = client.list_workspaces request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::Workspace.
  p item
end

#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)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#make_directory

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

Creates a directory inside a Workspace.

Overloads 
def make_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1::MakeDirectoryResponse
Pass arguments to make_directory via a request object, either of type MakeDirectoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::MakeDirectoryRequest.new

# Call the make_directory method.
result = client.make_directory request

# The returned object is of type Google::Cloud::Dataform::V1::MakeDirectoryResponse.
p result

#move_directory

def move_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1::MoveDirectoryResponse
def move_directory(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1::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::V1::MoveDirectoryResponse
Pass arguments to move_directory via a request object, either of type MoveDirectoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::MoveDirectoryRequest.new

# Call the move_directory method.
result = client.move_directory request

# The returned object is of type Google::Cloud::Dataform::V1::MoveDirectoryResponse.
p result

#move_file

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

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

Overloads 
def move_file(request, options = nil) -> ::Google::Cloud::Dataform::V1::MoveFileResponse
Pass arguments to move_file via a request object, either of type MoveFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::MoveFileRequest.new

# Call the move_file method.
result = client.move_file request

# The returned object is of type Google::Cloud::Dataform::V1::MoveFileResponse.
p result

#move_folder

def move_folder(request, options = nil) -> ::Gapic::Operation
def move_folder(name: nil, destination_containing_folder: nil) -> ::Gapic::Operation

Moves a Folder to a new Folder, TeamFolder, or the root location.

Overloads 
def move_folder(request, options = nil) -> ::Gapic::Operation
Pass arguments to move_folder via a request object, either of type MoveFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::MoveFolderRequest, ::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_folder(name: nil, destination_containing_folder: nil) -> ::Gapic::Operation
Pass arguments to move_folder 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 full resource name of the Folder to move.
  • destination_containing_folder (::String) — Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, projects/*/locations/*/folders/*, projects/*/locations/*/teamFolders/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::MoveFolderRequest.new

# Call the move_folder method.
result = client.move_folder request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#move_repository

def move_repository(request, options = nil) -> ::Gapic::Operation
def move_repository(name: nil, destination_containing_folder: nil) -> ::Gapic::Operation

Moves a Repository to a new location.

Overloads 
def move_repository(request, options = nil) -> ::Gapic::Operation
Pass arguments to move_repository via a request object, either of type MoveRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::MoveRepositoryRequest, ::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_repository(name: nil, destination_containing_folder: nil) -> ::Gapic::Operation
Pass arguments to move_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 full resource name of the repository to move.
  • destination_containing_folder (::String) — Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, projects/*/locations/*/folders/*, projects/*/locations/*/teamFolders/*
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::MoveRepositoryRequest.new

# Call the move_repository method.
result = client.move_repository request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#operations_client

def operations_client() -> ::Google::Cloud::Dataform::V1::Dataform::Rest::Operations

Get the associated client for long-running operations.

Returns

#pull_git_commits

def pull_git_commits(request, options = nil) -> ::Google::Cloud::Dataform::V1::PullGitCommitsResponse
def pull_git_commits(name: nil, remote_branch: nil, author: nil) -> ::Google::Cloud::Dataform::V1::PullGitCommitsResponse

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

Overloads 
def pull_git_commits(request, options = nil) -> ::Google::Cloud::Dataform::V1::PullGitCommitsResponse
Pass arguments to pull_git_commits via a request object, either of type PullGitCommitsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::Cloud::Dataform::V1::PullGitCommitsResponse
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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::PullGitCommitsRequest.new

# Call the pull_git_commits method.
result = client.pull_git_commits request

# The returned object is of type Google::Cloud::Dataform::V1::PullGitCommitsResponse.
p result

#push_git_commits

def push_git_commits(request, options = nil) -> ::Google::Cloud::Dataform::V1::PushGitCommitsResponse
def push_git_commits(name: nil, remote_branch: nil) -> ::Google::Cloud::Dataform::V1::PushGitCommitsResponse

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

Overloads 
def push_git_commits(request, options = nil) -> ::Google::Cloud::Dataform::V1::PushGitCommitsResponse
Pass arguments to push_git_commits via a request object, either of type PushGitCommitsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::Cloud::Dataform::V1::PushGitCommitsResponse
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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::PushGitCommitsRequest.new

# Call the push_git_commits method.
result = client.push_git_commits request

# The returned object is of type Google::Cloud::Dataform::V1::PushGitCommitsResponse.
p result

#query_compilation_result_actions

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

Returns CompilationResultActions in a given CompilationResult.

Overloads 
def query_compilation_result_actions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::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::V1::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::V1::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, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::QueryCompilationResultActionsRequest.new

# Call the query_compilation_result_actions method.
result = client.query_compilation_result_actions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::CompilationResultAction.
  p item
end

#query_directory_contents

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

Returns the contents of a given Workspace directory.

Overloads 
def query_directory_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>
Pass arguments to query_directory_contents via a request object, either of type QueryDirectoryContentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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, view: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::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, with the exception of page_size, must match the call that provided the page token.

  • view (::Google::Cloud::Dataform::V1::DirectoryContentsView) — Optional. Specifies the metadata to return for each directory entry. If unspecified, the default is DIRECTORY_CONTENTS_VIEW_BASIC. Currently the DIRECTORY_CONTENTS_VIEW_METADATA view is not supported by CMEK-protected workspaces.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::QueryDirectoryContentsRequest.new

# Call the query_directory_contents method.
result = client.query_directory_contents request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::DirectoryEntry.
  p item
end

#query_folder_contents

def query_folder_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>
def query_folder_contents(folder: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>

Returns the contents of a given Folder.

Overloads 
def query_folder_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>
Pass arguments to query_folder_contents via a request object, either of type QueryFolderContentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::QueryFolderContentsRequest, ::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_folder_contents(folder: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>
Pass arguments to query_folder_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
  • folder (::String) — Required. Name of the folder whose contents to list. Format: projects//locations//folders/*
  • 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 QueryFolderContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryFolderContents, with the exception of page_size, must match the call that provided the page token.

  • order_by (::String) —

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

    • orderBy="display_name"
    • orderBy="display_name desc"
  • filter (::String) —

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

    Example:

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

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::QueryFolderContentsRequest.new

# Call the query_folder_contents method.
result = client.query_folder_contents request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry.
  p item
end

#query_repository_directory_contents

def query_repository_directory_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>
def query_repository_directory_contents(name: nil, commit_sha: nil, path: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>

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

Overloads 
def query_repository_directory_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>
Pass arguments to query_repository_directory_contents via a request object, either of type QueryRepositoryDirectoryContentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::QueryRepositoryDirectoryContentsRequest, ::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_repository_directory_contents(name: nil, commit_sha: nil, path: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>
Pass arguments to query_repository_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
  • name (::String) — Required. The repository's name.
  • commit_sha (::String) — Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.
  • path (::String) — Optional. The directory's full path including directory name, relative to root. If left unset, the 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 QueryRepositoryDirectoryContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryRepositoryDirectoryContents, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::QueryRepositoryDirectoryContentsRequest.new

# Call the query_repository_directory_contents method.
result = client.query_repository_directory_contents request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::DirectoryEntry.
  p item
end

#query_team_folder_contents

def query_team_folder_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>
def query_team_folder_contents(team_folder: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>

Returns the contents of a given TeamFolder.

Overloads 
def query_team_folder_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>
Pass arguments to query_team_folder_contents via a request object, either of type QueryTeamFolderContentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::QueryTeamFolderContentsRequest, ::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_team_folder_contents(team_folder: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>
Pass arguments to query_team_folder_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
  • team_folder (::String) — Required. Name of the team_folder whose contents to list. Format: projects/*/locations/*/teamFolders/*.
  • 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 QueryTeamFolderContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryTeamFolderContents, with the exception of page_size, must match the call that provided the page token.

  • order_by (::String) —

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

    • orderBy="display_name"
    • orderBy="display_name desc"
  • filter (::String) —

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

    Example:

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

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::QueryTeamFolderContentsRequest.new

# Call the query_team_folder_contents method.
result = client.query_team_folder_contents request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry.
  p item
end

#query_user_root_contents

def query_user_root_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>
def query_user_root_contents(location: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>

Returns the contents of a caller's root folder in a given location. The root folder contains all resources that are created by the user and not contained in any other folder.

Overloads 
def query_user_root_contents(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>
Pass arguments to query_user_root_contents via a request object, either of type QueryUserRootContentsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::QueryUserRootContentsRequest, ::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_user_root_contents(location: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>
Pass arguments to query_user_root_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
  • location (::String) — Required. Location of the user root folder whose contents to list. Format: projects//locations/
  • 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 QueryUserRootContents call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to QueryUserRootFolderContents, with the exception of page_size, must match the call that provided the page token.

  • order_by (::String) —

    Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples:

    • orderBy="display_name"
    • orderBy="display_name desc"
  • filter (::String) —

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

    Example:

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

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::QueryUserRootContentsRequest.new

# Call the query_user_root_contents method.
result = client.query_user_root_contents request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry.
  p item
end

#query_workflow_invocation_actions

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

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Overloads 
def query_workflow_invocation_actions(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::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::V1::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::V1::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, with the exception of page_size, 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::QueryWorkflowInvocationActionsRequest.new

# Call the query_workflow_invocation_actions method.
result = client.query_workflow_invocation_actions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::WorkflowInvocationAction.
  p item
end

#read_file

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

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

Overloads 
def read_file(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReadFileResponse
Pass arguments to read_file via a request object, either of type ReadFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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, revision: nil) -> ::Google::Cloud::Dataform::V1::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.
  • revision (::String) — Optional. The Git revision of the file to return. If left empty, the current contents of path will be returned.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ReadFileRequest.new

# Call the read_file method.
result = client.read_file request

# The returned object is of type Google::Cloud::Dataform::V1::ReadFileResponse.
p result

#read_repository_file

def read_repository_file(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReadRepositoryFileResponse
def read_repository_file(name: nil, commit_sha: nil, path: nil) -> ::Google::Cloud::Dataform::V1::ReadRepositoryFileResponse

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

Overloads 
def read_repository_file(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReadRepositoryFileResponse
Pass arguments to read_repository_file via a request object, either of type ReadRepositoryFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::ReadRepositoryFileRequest, ::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_repository_file(name: nil, commit_sha: nil, path: nil) -> ::Google::Cloud::Dataform::V1::ReadRepositoryFileResponse
Pass arguments to read_repository_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
  • name (::String) — Required. The repository's name.
  • commit_sha (::String) — Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.
  • path (::String) — Required. Full file path to read including filename, from repository 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ReadRepositoryFileRequest.new

# Call the read_repository_file method.
result = client.read_repository_file request

# The returned object is of type Google::Cloud::Dataform::V1::ReadRepositoryFileResponse.
p result

#remove_directory

def remove_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1::RemoveDirectoryResponse
def remove_directory(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1::RemoveDirectoryResponse

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

Overloads 
def remove_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1::RemoveDirectoryResponse
Pass arguments to remove_directory via a request object, either of type RemoveDirectoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::Cloud::Dataform::V1::RemoveDirectoryResponse
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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::RemoveDirectoryRequest.new

# Call the remove_directory method.
result = client.remove_directory request

# The returned object is of type Google::Cloud::Dataform::V1::RemoveDirectoryResponse.
p result

#remove_file

def remove_file(request, options = nil) -> ::Google::Cloud::Dataform::V1::RemoveFileResponse
def remove_file(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1::RemoveFileResponse

Deletes a file (inside a Workspace).

Overloads 
def remove_file(request, options = nil) -> ::Google::Cloud::Dataform::V1::RemoveFileResponse
Pass arguments to remove_file via a request object, either of type RemoveFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::Cloud::Dataform::V1::RemoveFileResponse
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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::RemoveFileRequest.new

# Call the remove_file method.
result = client.remove_file request

# The returned object is of type Google::Cloud::Dataform::V1::RemoveFileResponse.
p result

#reset_workspace_changes

def reset_workspace_changes(request, options = nil) -> ::Google::Cloud::Dataform::V1::ResetWorkspaceChangesResponse
def reset_workspace_changes(name: nil, paths: nil, clean: nil) -> ::Google::Cloud::Dataform::V1::ResetWorkspaceChangesResponse

Performs a Git reset for uncommitted files in a Workspace.

Overloads 
def reset_workspace_changes(request, options = nil) -> ::Google::Cloud::Dataform::V1::ResetWorkspaceChangesResponse
Pass arguments to reset_workspace_changes via a request object, either of type ResetWorkspaceChangesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::Cloud::Dataform::V1::ResetWorkspaceChangesResponse
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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::ResetWorkspaceChangesRequest.new

# Call the reset_workspace_changes method.
result = client.reset_workspace_changes request

# The returned object is of type Google::Cloud::Dataform::V1::ResetWorkspaceChangesResponse.
p result

#search_files

def search_files(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchResult>
def search_files(workspace: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchResult>

Finds the contents of a given Workspace directory by filter.

Overloads 
def search_files(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchResult>
Pass arguments to search_files via a request object, either of type SearchFilesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::SearchFilesRequest, ::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 search_files(workspace: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchResult>
Pass arguments to search_files 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.
  • page_size (::Integer) — Optional. Maximum number of search 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 SearchFilesRequest call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to SearchFilesRequest, with the exception of page_size, must match the call that provided the page token.

  • filter (::String) — Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::SearchFilesRequest.new

# Call the search_files method.
result = client.search_files request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::SearchResult.
  p item
end

#search_team_folders

def search_team_folders(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>
def search_team_folders(location: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>

Returns all TeamFolders in a given location that the caller has access to and match the provided filter.

Overloads 
def search_team_folders(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>
Pass arguments to search_team_folders via a request object, either of type SearchTeamFoldersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::SearchTeamFoldersRequest, ::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 search_team_folders(location: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>
Pass arguments to search_team_folders 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
  • location (::String) — Required. Location in which to query TeamFolders. Format: projects/*/locations/*.
  • page_size (::Integer) — Optional. Maximum number of TeamFolders 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 SearchTeamFolders call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to SearchTeamFolders, with the exception of page_size, must match the call that provided the page token.

  • order_by (::String) —

    Optional. Field to additionally sort results by. Supported keywords: display_name (default), create_time, last_modified_time. Examples:

    • orderBy="display_name"
    • orderBy="display_name desc"
  • filter (::String) —

    Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

    Example:

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

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::SearchTeamFoldersRequest.new

# Call the search_team_folders method.
result = client.search_team_folders request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult.
  p item
end

#set_iam_policy

def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
def set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Overloads 
def set_iam_policy(request, options = nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::SetIamPolicyRequest, ::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 set_iam_policy(resource: nil, policy: nil, update_mask: nil) -> ::Google::Iam::V1::Policy
Pass arguments to set_iam_policy 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
  • resource (::String) — REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • policy (::Google::Iam::V1::Policy, ::Hash) — REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

    paths: "bindings, etag"

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

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

# Call the set_iam_policy method.
result = client.set_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

#test_iam_permissions

def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
def test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse

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.

Overloads 
def test_iam_permissions(request, options = nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Iam::V1::TestIamPermissionsRequest, ::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 test_iam_permissions(resource: nil, permissions: nil) -> ::Google::Iam::V1::TestIamPermissionsResponse
Pass arguments to test_iam_permissions 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
  • resource (::String) — REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • permissions (::Array<::String>) — The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Google::Iam::V1::TestIamPermissionsResponse)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Google::Iam::V1::TestIamPermissionsResponse)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

# Call the test_iam_permissions method.
result = client.test_iam_permissions request

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_config

def update_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::Config
def update_config(config: nil, update_mask: nil) -> ::Google::Cloud::Dataform::V1::Config

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.

Overloads 
def update_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::Config
Pass arguments to update_config via a request object, either of type UpdateConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::UpdateConfigRequest, ::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_config(config: nil, update_mask: nil) -> ::Google::Cloud::Dataform::V1::Config
Pass arguments to update_config 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateConfigRequest.new

# Call the update_config method.
result = client.update_config request

# The returned object is of type Google::Cloud::Dataform::V1::Config.
p result

#update_folder

def update_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::Folder
def update_folder(update_mask: nil, folder: nil) -> ::Google::Cloud::Dataform::V1::Folder

Updates a single Folder.

Overloads 
def update_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::Folder
Pass arguments to update_folder via a request object, either of type UpdateFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::UpdateFolderRequest, ::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_folder(update_mask: nil, folder: nil) -> ::Google::Cloud::Dataform::V1::Folder
Pass arguments to update_folder 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
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Specifies the fields to be updated in the Folder. If left unset, all fields that can be updated, will be updated. A few fields cannot be updated and will be ignored if specified in the update_mask (e.g. parent_name, team_folder_name).
  • folder (::Google::Cloud::Dataform::V1::Folder, ::Hash) — Required. The updated Folder.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateFolderRequest.new

# Call the update_folder method.
result = client.update_folder request

# The returned object is of type Google::Cloud::Dataform::V1::Folder.
p result

#update_release_config

def update_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
def update_release_config(update_mask: nil, release_config: nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig

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.

Overloads 
def update_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
Pass arguments to update_release_config via a request object, either of type UpdateReleaseConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::UpdateReleaseConfigRequest, ::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_release_config(update_mask: nil, release_config: nil) -> ::Google::Cloud::Dataform::V1::ReleaseConfig
Pass arguments to update_release_config 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateReleaseConfigRequest.new

# Call the update_release_config method.
result = client.update_release_config request

# The returned object is of type Google::Cloud::Dataform::V1::ReleaseConfig.
p result

#update_repository

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

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.

Overloads 
def update_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1::Repository
Pass arguments to update_repository via a request object, either of type UpdateRepositoryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateRepositoryRequest.new

# Call the update_repository method.
result = client.update_repository request

# The returned object is of type Google::Cloud::Dataform::V1::Repository.
p result

#update_team_folder

def update_team_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
def update_team_folder(update_mask: nil, team_folder: nil) -> ::Google::Cloud::Dataform::V1::TeamFolder

Updates a single TeamFolder.

Overloads 
def update_team_folder(request, options = nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
Pass arguments to update_team_folder via a request object, either of type UpdateTeamFolderRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::UpdateTeamFolderRequest, ::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_team_folder(update_mask: nil, team_folder: nil) -> ::Google::Cloud::Dataform::V1::TeamFolder
Pass arguments to update_team_folder 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateTeamFolderRequest.new

# Call the update_team_folder method.
result = client.update_team_folder request

# The returned object is of type Google::Cloud::Dataform::V1::TeamFolder.
p result

#update_workflow_config

def update_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
def update_workflow_config(update_mask: nil, workflow_config: nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig

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.

Overloads 
def update_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
Pass arguments to update_workflow_config via a request object, either of type UpdateWorkflowConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::UpdateWorkflowConfigRequest, ::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_workflow_config(update_mask: nil, workflow_config: nil) -> ::Google::Cloud::Dataform::V1::WorkflowConfig
Pass arguments to update_workflow_config 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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateWorkflowConfigRequest.new

# Call the update_workflow_config method.
result = client.update_workflow_config request

# The returned object is of type Google::Cloud::Dataform::V1::WorkflowConfig.
p result

#write_file

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

Writes to a file (inside a Workspace).

Overloads 
def write_file(request, options = nil) -> ::Google::Cloud::Dataform::V1::WriteFileResponse
Pass arguments to write_file via a request object, either of type WriteFileRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Dataform::V1::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::V1::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.
Example

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::WriteFileRequest.new

# Call the write_file method.
result = client.write_file request

# The returned object is of type Google::Cloud::Dataform::V1::WriteFileResponse.
p result