Reference documentation and code samples for the Dataform V1beta1 API class Google::Cloud::Dataform::V1beta1::Dataform::Client.
Client for the Dataform service.
Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Dataform Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Dataform clients ::Google::Cloud::Dataform::V1beta1::Dataform::Client.configure do |config| config.timeout = 10.0 end
#cancel_workflow_invocation
def cancel_workflow_invocation(request, options = nil) -> ::Google::Protobuf::Empty
def cancel_workflow_invocation(name: nil) -> ::Google::Protobuf::Empty
Requests cancellation of a running WorkflowInvocation.
def cancel_workflow_invocation(request, options = nil) -> ::Google::Protobuf::Empty
cancel_workflow_invocation
via a request object, either of type
CancelWorkflowInvocationRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def cancel_workflow_invocation(name: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — Required. The workflow invocation resource's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationRequest.new # Call the cancel_workflow_invocation method. result = client.cancel_workflow_invocation request # The returned object is of type Google::Protobuf::Empty. p result
#commit_repository_changes
def commit_repository_changes(request, options = nil) -> ::Google::Protobuf::Empty
def commit_repository_changes(name: nil, commit_metadata: nil, required_head_commit_sha: nil, file_operations: nil) -> ::Google::Protobuf::Empty
Applies a Git commit to a Repository. The Repository must not have a value
for git_remote_settings.url
.
def commit_repository_changes(request, options = nil) -> ::Google::Protobuf::Empty
commit_repository_changes
via a request object, either of type
CommitRepositoryChangesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::Protobuf::Empty
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).
- name (::String) — Required. The repository's name.
- commit_metadata (::Google::Cloud::Dataform::V1beta1::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::V1beta1::CommitRepositoryChangesRequest::FileOperation, ::Hash}) — A map to the path of the file to the operation. The path is the full file path including filename, from repository root.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest.new # Call the commit_repository_changes method. result = client.commit_repository_changes request # The returned object is of type Google::Protobuf::Empty. p result
#commit_workspace_changes
def commit_workspace_changes(request, options = nil) -> ::Google::Protobuf::Empty
def commit_workspace_changes(name: nil, author: nil, commit_message: nil, paths: nil) -> ::Google::Protobuf::Empty
Applies a Git commit for uncommitted files in a Workspace.
def commit_workspace_changes(request, options = nil) -> ::Google::Protobuf::Empty
commit_workspace_changes
via a request object, either of type
CommitWorkspaceChangesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def commit_workspace_changes(name: nil, author: nil, commit_message: nil, paths: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — Required. The workspace's name.
- author (::Google::Cloud::Dataform::V1beta1::CommitAuthor, ::Hash) — Required. The commit's author.
- commit_message (::String) — Optional. The commit's message.
- paths (::Array<::String>) — Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesRequest.new # Call the commit_workspace_changes method. result = client.commit_workspace_changes request # The returned object is of type Google::Protobuf::Empty. p result
#compute_repository_access_token_status
def compute_repository_access_token_status(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusResponse
def compute_repository_access_token_status(name: nil) -> ::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusResponse
Computes a Repository's Git access token status.
def compute_repository_access_token_status(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusResponse
compute_repository_access_token_status
via a request object, either of type
ComputeRepositoryAccessTokenStatusRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::V1beta1::ComputeRepositoryAccessTokenStatusResponse
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).
- name (::String) — Required. The repository's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::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.
- (config) — Configure the Client client.
- config (Client::Configuration)
#create_compilation_result
def create_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
def create_compilation_result(parent: nil, compilation_result: nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
Creates a new CompilationResult in a given project and location.
def create_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
create_compilation_result
via a request object, either of type
CreateCompilationResultRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::CreateCompilationResultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_compilation_result(parent: nil, compilation_result: nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
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).
-
parent (::String) — Required. The repository in which to create the compilation result. Must be
in the format
projects/*/locations/*/repositories/*
. - compilation_result (::Google::Cloud::Dataform::V1beta1::CompilationResult, ::Hash) — Required. The compilation result to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::CompilationResult)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CreateCompilationResultRequest.new # Call the create_compilation_result method. result = client.create_compilation_result request # The returned object is of type Google::Cloud::Dataform::V1beta1::CompilationResult. p result
#create_release_config
def create_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
def create_release_config(parent: nil, release_config: nil, release_config_id: nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
Creates a new ReleaseConfig in a given Repository.
def create_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
create_release_config
via a request object, either of type
CreateReleaseConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::V1beta1::ReleaseConfig
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).
-
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::V1beta1::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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::ReleaseConfig)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CreateReleaseConfigRequest.new # Call the create_release_config method. result = client.create_release_config request # The returned object is of type Google::Cloud::Dataform::V1beta1::ReleaseConfig. p result
#create_repository
def create_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
def create_repository(parent: nil, repository: nil, repository_id: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Creates a new Repository in a given project and location.
def create_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
create_repository
via a request object, either of type
CreateRepositoryRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::CreateRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_repository(parent: nil, repository: nil, repository_id: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
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).
-
parent (::String) — Required. The location in which to create the repository. Must be in the
format
projects/*/locations/*
. - repository (::Google::Cloud::Dataform::V1beta1::Repository, ::Hash) — Required. The repository to create.
- repository_id (::String) — Required. The ID to use for the repository, which will become the final component of the repository's resource name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::Repository)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CreateRepositoryRequest.new # Call the create_repository method. result = client.create_repository request # The returned object is of type Google::Cloud::Dataform::V1beta1::Repository. p result
#create_workflow_config
def create_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
def create_workflow_config(parent: nil, workflow_config: nil, workflow_config_id: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
Creates a new WorkflowConfig in a given Repository.
def create_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
create_workflow_config
via a request object, either of type
CreateWorkflowConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::V1beta1::WorkflowConfig
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).
-
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::V1beta1::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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::WorkflowConfig)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CreateWorkflowConfigRequest.new # Call the create_workflow_config method. result = client.create_workflow_config request # The returned object is of type Google::Cloud::Dataform::V1beta1::WorkflowConfig. p result
#create_workflow_invocation
def create_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
def create_workflow_invocation(parent: nil, workflow_invocation: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
Creates a new WorkflowInvocation in a given Repository.
def create_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
create_workflow_invocation
via a request object, either of type
CreateWorkflowInvocationRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::CreateWorkflowInvocationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_workflow_invocation(parent: nil, workflow_invocation: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
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).
-
parent (::String) — Required. The repository in which to create the workflow invocation. Must
be in the format
projects/*/locations/*/repositories/*
. - workflow_invocation (::Google::Cloud::Dataform::V1beta1::WorkflowInvocation, ::Hash) — Required. The workflow invocation resource to create.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::WorkflowInvocation)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CreateWorkflowInvocationRequest.new # Call the create_workflow_invocation method. result = client.create_workflow_invocation request # The returned object is of type Google::Cloud::Dataform::V1beta1::WorkflowInvocation. p result
#create_workspace
def create_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
def create_workspace(parent: nil, workspace: nil, workspace_id: nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
Creates a new Workspace in a given Repository.
def create_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
create_workspace
via a request object, either of type
CreateWorkspaceRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::CreateWorkspaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def create_workspace(parent: nil, workspace: nil, workspace_id: nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
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).
-
parent (::String) — Required. The repository in which to create the workspace. Must be in the
format
projects/*/locations/*/repositories/*
. - workspace (::Google::Cloud::Dataform::V1beta1::Workspace, ::Hash) — Required. The workspace to create.
- workspace_id (::String) — Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::Workspace)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::CreateWorkspaceRequest.new # Call the create_workspace method. result = client.create_workspace request # The returned object is of type Google::Cloud::Dataform::V1beta1::Workspace. p result
#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.
def delete_release_config(request, options = nil) -> ::Google::Protobuf::Empty
delete_release_config
via a request object, either of type
Google::Cloud::Dataform::V1beta1::DeleteReleaseConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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
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).
- name (::String) — Required. The release config's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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.
def delete_repository(request, options = nil) -> ::Google::Protobuf::Empty
delete_repository
via a request object, either of type
Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_repository(name: nil, force: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — Required. The repository's name.
- force (::Boolean) — If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest.new # Call the delete_repository method. result = client.delete_repository request # The returned object is of type Google::Protobuf::Empty. p result
#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.
def delete_workflow_config(request, options = nil) -> ::Google::Protobuf::Empty
delete_workflow_config
via a request object, either of type
Google::Cloud::Dataform::V1beta1::DeleteWorkflowConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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
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).
- name (::String) — Required. The workflow config's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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.
def delete_workflow_invocation(request, options = nil) -> ::Google::Protobuf::Empty
delete_workflow_invocation
via a request object, either of type
Google::Cloud::Dataform::V1beta1::DeleteWorkflowInvocationRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::DeleteWorkflowInvocationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_workflow_invocation(name: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — Required. The workflow invocation resource's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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.
def delete_workspace(request, options = nil) -> ::Google::Protobuf::Empty
delete_workspace
via a request object, either of type
Google::Cloud::Dataform::V1beta1::DeleteWorkspaceRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::DeleteWorkspaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def delete_workspace(name: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — Required. The workspace resource's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::FetchFileDiffResponse
def fetch_file_diff(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse
Fetches Git diff for an uncommitted file in a Workspace.
def fetch_file_diff(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse
fetch_file_diff
via a request object, either of type
FetchFileDiffRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::FetchFileDiffRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def fetch_file_diff(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse
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).
- workspace (::String) — Required. The workspace's name.
- path (::String) — Required. The file's full path including filename, relative to the workspace root.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::FetchFileDiffRequest.new # Call the fetch_file_diff method. result = client.fetch_file_diff request # The returned object is of type Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse. p result
#fetch_file_git_statuses
def fetch_file_git_statuses(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse
def fetch_file_git_statuses(name: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse
Fetches Git statuses for the files in a Workspace.
def fetch_file_git_statuses(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse
fetch_file_git_statuses
via a request object, either of type
FetchFileGitStatusesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def fetch_file_git_statuses(name: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse
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).
- name (::String) — Required. The workspace's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::FetchFileGitStatusesResponse. p result
#fetch_git_ahead_behind
def fetch_git_ahead_behind(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse
def fetch_git_ahead_behind(name: nil, remote_branch: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse
Fetches Git ahead/behind against a remote branch.
def fetch_git_ahead_behind(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse
fetch_git_ahead_behind
via a request object, either of type
FetchGitAheadBehindRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def fetch_git_ahead_behind(name: nil, remote_branch: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::FetchGitAheadBehindResponse. p result
#fetch_remote_branches
def fetch_remote_branches(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse
def fetch_remote_branches(name: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse
Fetches a Repository's remote branches.
def fetch_remote_branches(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse
fetch_remote_branches
via a request object, either of type
FetchRemoteBranchesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def fetch_remote_branches(name: nil) -> ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse
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).
- name (::String) — Required. The repository's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesRequest.new # Call the fetch_remote_branches method. result = client.fetch_remote_branches request # The returned object is of type Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse. p result
#fetch_repository_history
def fetch_repository_history(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>
def fetch_repository_history(name: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>
Fetches a Repository's history of commits. The Repository must not have a
value for git_remote_settings.url
.
def fetch_repository_history(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>
fetch_repository_history
via a request object, either of type
FetchRepositoryHistoryRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>
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).
- 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
must match the call that provided the page token.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::CommitLogEntry. p item end
#get_compilation_result
def get_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
def get_compilation_result(name: nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
Fetches a single CompilationResult.
def get_compilation_result(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
get_compilation_result
via a request object, either of type
GetCompilationResultRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::GetCompilationResultRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_compilation_result(name: nil) -> ::Google::Cloud::Dataform::V1beta1::CompilationResult
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).
- name (::String) — Required. The compilation result's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::CompilationResult)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::GetCompilationResultRequest.new # Call the get_compilation_result method. result = client.get_compilation_result request # The returned object is of type Google::Cloud::Dataform::V1beta1::CompilationResult. p result
#get_release_config
def get_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
def get_release_config(name: nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
Fetches a single ReleaseConfig.
def get_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
get_release_config
via a request object, either of type
GetReleaseConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::V1beta1::ReleaseConfig
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).
- name (::String) — Required. The release config's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::ReleaseConfig)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::GetReleaseConfigRequest.new # Call the get_release_config method. result = client.get_release_config request # The returned object is of type Google::Cloud::Dataform::V1beta1::ReleaseConfig. p result
#get_repository
def get_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
def get_repository(name: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Fetches a single Repository.
def get_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
get_repository
via a request object, either of type
GetRepositoryRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::GetRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_repository(name: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
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).
- name (::String) — Required. The repository's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::Repository)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::GetRepositoryRequest.new # Call the get_repository method. result = client.get_repository request # The returned object is of type Google::Cloud::Dataform::V1beta1::Repository. p result
#get_workflow_config
def get_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
def get_workflow_config(name: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
Fetches a single WorkflowConfig.
def get_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
get_workflow_config
via a request object, either of type
GetWorkflowConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::V1beta1::WorkflowConfig
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).
- name (::String) — Required. The workflow config's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::WorkflowConfig)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::GetWorkflowConfigRequest.new # Call the get_workflow_config method. result = client.get_workflow_config request # The returned object is of type Google::Cloud::Dataform::V1beta1::WorkflowConfig. p result
#get_workflow_invocation
def get_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
def get_workflow_invocation(name: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
Fetches a single WorkflowInvocation.
def get_workflow_invocation(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
get_workflow_invocation
via a request object, either of type
GetWorkflowInvocationRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::GetWorkflowInvocationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_workflow_invocation(name: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation
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).
- name (::String) — Required. The workflow invocation resource's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::WorkflowInvocation)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::GetWorkflowInvocationRequest.new # Call the get_workflow_invocation method. result = client.get_workflow_invocation request # The returned object is of type Google::Cloud::Dataform::V1beta1::WorkflowInvocation. p result
#get_workspace
def get_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
def get_workspace(name: nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
Fetches a single Workspace.
def get_workspace(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
get_workspace
via a request object, either of type
GetWorkspaceRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::GetWorkspaceRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def get_workspace(name: nil) -> ::Google::Cloud::Dataform::V1beta1::Workspace
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).
- name (::String) — Required. The workspace's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::Workspace)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::GetWorkspaceRequest.new # Call the get_workspace method. result = client.get_workspace request # The returned object is of type Google::Cloud::Dataform::V1beta1::Workspace. p result
#iam_policy_client
def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client
Get the associated client for mix-in of the IAMPolicy.
- (Google::Iam::V1::IAMPolicy::Client)
#initialize
def initialize() { |config| ... } -> Client
Create a new Dataform client object.
- (config) — Configure the Dataform client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dataform::V1beta1::Dataform::Client.new do |config| config.timeout = 10.0 end
#install_npm_packages
def install_npm_packages(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse
def install_npm_packages(workspace: nil) -> ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse
Installs dependency NPM packages (inside a Workspace).
def install_npm_packages(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse
install_npm_packages
via a request object, either of type
InstallNpmPackagesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def install_npm_packages(workspace: nil) -> ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse
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).
- workspace (::String) — Required. The workspace's name.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::InstallNpmPackagesRequest.new # Call the install_npm_packages method. result = client.install_npm_packages request # The returned object is of type Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse. p result
#list_compilation_results
def list_compilation_results(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>
def list_compilation_results(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>
Lists CompilationResults in a given Repository.
def list_compilation_results(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>
list_compilation_results
via a request object, either of type
ListCompilationResultsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::ListCompilationResultsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_compilation_results(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>
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).
-
parent (::String) — Required. The repository in which to list compilation results. Must be in
the format
projects/*/locations/*/repositories/*
. - page_size (::Integer) — Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
-
page_token (::String) — Optional. Page token received from a previous
ListCompilationResults
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListCompilationResults
must match the call that provided the page token.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::CompilationResult. p item end
#list_release_configs
def list_release_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>
def list_release_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>
Lists ReleaseConfigs in a given Repository.
def list_release_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>
list_release_configs
via a request object, either of type
ListReleaseConfigsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>
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).
-
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
must match the call that provided the page token.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::ReleaseConfig. p item end
#list_repositories
def list_repositories(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>
def list_repositories(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>
Lists Repositories in a given project and location.
def list_repositories(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>
list_repositories
via a request object, either of type
ListRepositoriesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::ListRepositoriesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_repositories(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>
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).
-
parent (::String) — Required. The location in which to list repositories. Must be in the format
projects/*/locations/*
. - page_size (::Integer) — Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
-
page_token (::String) — Optional. Page token received from a previous
ListRepositories
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListRepositories
must match the call that provided the page token. -
order_by (::String) — Optional. This field only supports ordering by
name
. If unspecified, the server will choose the ordering. If specified, the default order is ascending for thename
field. - filter (::String) — Optional. Filter for the returned list.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::Repository. p item end
#list_workflow_configs
def list_workflow_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>
def list_workflow_configs(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>
Lists WorkflowConfigs in a given Repository.
def list_workflow_configs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>
list_workflow_configs
via a request object, either of type
ListWorkflowConfigsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>
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).
-
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
must match the call that provided the page token.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::WorkflowConfig. p item end
#list_workflow_invocations
def list_workflow_invocations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>
def list_workflow_invocations(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>
Lists WorkflowInvocations in a given Repository.
def list_workflow_invocations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>
list_workflow_invocations
via a request object, either of type
ListWorkflowInvocationsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_workflow_invocations(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>
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).
-
parent (::String) — Required. The parent resource of the WorkflowInvocation type. Must be in
the format
projects/*/locations/*/repositories/*
. - page_size (::Integer) — Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
-
page_token (::String) — Optional. Page token received from a previous
ListWorkflowInvocations
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListWorkflowInvocations
must match the call that provided the page token. -
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 thename
field. - filter (::String) — Optional. Filter for the returned list.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::WorkflowInvocation. p item end
#list_workspaces
def list_workspaces(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>
def list_workspaces(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>
Lists Workspaces in a given Repository.
def list_workspaces(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>
list_workspaces
via a request object, either of type
ListWorkspacesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::ListWorkspacesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def list_workspaces(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>
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).
-
parent (::String) — Required. The repository in which to list workspaces. Must be in the
format
projects/*/locations/*/repositories/*
. - page_size (::Integer) — Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
-
page_token (::String) — Optional. Page token received from a previous
ListWorkspaces
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListWorkspaces
must match the call that provided the page token. -
order_by (::String) — Optional. This field only supports ordering by
name
. If unspecified, the server will choose the ordering. If specified, the default order is ascending for thename
field. - filter (::String) — Optional. Filter for the returned list.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::Workspace. p item end
#location_client
def location_client() -> Google::Cloud::Location::Locations::Client
Get the associated client for mix-in of the Locations.
- (Google::Cloud::Location::Locations::Client)
#make_directory
def make_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse
def make_directory(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse
Creates a directory inside a Workspace.
def make_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse
make_directory
via a request object, either of type
MakeDirectoryRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::MakeDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def make_directory(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse
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).
- workspace (::String) — Required. The workspace's name.
- path (::String) — Required. The directory's full path including directory name, relative to the workspace root.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::MakeDirectoryRequest.new # Call the make_directory method. result = client.make_directory request # The returned object is of type Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse. p result
#move_directory
def move_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse
def move_directory(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse
Moves a directory (inside a Workspace), and all of its contents, to a new location.
def move_directory(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse
move_directory
via a request object, either of type
MoveDirectoryRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::MoveDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def move_directory(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::MoveDirectoryRequest.new # Call the move_directory method. result = client.move_directory request # The returned object is of type Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse. p result
#move_file
def move_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MoveFileResponse
def move_file(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1beta1::MoveFileResponse
Moves a file (inside a Workspace) to a new location.
def move_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::MoveFileResponse
move_file
via a request object, either of type
MoveFileRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::MoveFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def move_file(workspace: nil, path: nil, new_path: nil) -> ::Google::Cloud::Dataform::V1beta1::MoveFileResponse
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::MoveFileResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::MoveFileRequest.new # Call the move_file method. result = client.move_file request # The returned object is of type Google::Cloud::Dataform::V1beta1::MoveFileResponse. p result
#pull_git_commits
def pull_git_commits(request, options = nil) -> ::Google::Protobuf::Empty
def pull_git_commits(name: nil, remote_branch: nil, author: nil) -> ::Google::Protobuf::Empty
Pulls Git commits from the Repository's remote into a Workspace.
def pull_git_commits(request, options = nil) -> ::Google::Protobuf::Empty
pull_git_commits
via a request object, either of type
PullGitCommitsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::PullGitCommitsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def pull_git_commits(name: nil, remote_branch: nil, author: nil) -> ::Google::Protobuf::Empty
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).
- name (::String) — Required. The workspace's name.
- remote_branch (::String) — Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.
- author (::Google::Cloud::Dataform::V1beta1::CommitAuthor, ::Hash) — Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::PullGitCommitsRequest.new # Call the pull_git_commits method. result = client.pull_git_commits request # The returned object is of type Google::Protobuf::Empty. p result
#push_git_commits
def push_git_commits(request, options = nil) -> ::Google::Protobuf::Empty
def push_git_commits(name: nil, remote_branch: nil) -> ::Google::Protobuf::Empty
Pushes Git commits from a Workspace to the Repository's remote.
def push_git_commits(request, options = nil) -> ::Google::Protobuf::Empty
push_git_commits
via a request object, either of type
PushGitCommitsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::PushGitCommitsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def push_git_commits(name: nil, remote_branch: nil) -> ::Google::Protobuf::Empty
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::PushGitCommitsRequest.new # Call the push_git_commits method. result = client.push_git_commits request # The returned object is of type Google::Protobuf::Empty. p result
#query_compilation_result_actions
def query_compilation_result_actions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>
def query_compilation_result_actions(name: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>
Returns CompilationResultActions in a given CompilationResult.
def query_compilation_result_actions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>
query_compilation_result_actions
via a request object, either of type
QueryCompilationResultActionsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::QueryCompilationResultActionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def query_compilation_result_actions(name: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>
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).
- name (::String) — Required. The compilation result's name.
- page_size (::Integer) — Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
-
page_token (::String) — Optional. Page token received from a previous
QueryCompilationResultActions
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
QueryCompilationResultActions
must match the call that provided the page token. -
filter (::String) — Optional. Optional filter for the returned list. Filtering is only
currently supported on the
file_path
field.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::CompilationResultAction. p item end
#query_directory_contents
def query_directory_contents(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>
def query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>
Returns the contents of a given Workspace directory.
def query_directory_contents(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>
query_directory_contents
via a request object, either of type
QueryDirectoryContentsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>
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).
- workspace (::String) — Required. The workspace's name.
- path (::String) — Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
- page_size (::Integer) — Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
-
page_token (::String) — Optional. Page token received from a previous
QueryDirectoryContents
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
QueryDirectoryContents
must match the call that provided the page token.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::DirectoryEntry. p item end
#query_repository_directory_contents
def query_repository_directory_contents(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>
def query_repository_directory_contents(name: nil, commit_sha: nil, path: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>
Returns the contents of a given Repository directory. The Repository must
not have a value for git_remote_settings.url
.
def query_repository_directory_contents(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>
query_repository_directory_contents
via a request object, either of type
QueryRepositoryDirectoryContentsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>
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).
- 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
must match the call that provided the page token.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::DirectoryEntry. p item end
#query_workflow_invocation_actions
def query_workflow_invocation_actions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>
def query_workflow_invocation_actions(name: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>
Returns WorkflowInvocationActions in a given WorkflowInvocation.
def query_workflow_invocation_actions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>
query_workflow_invocation_actions
via a request object, either of type
QueryWorkflowInvocationActionsRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::QueryWorkflowInvocationActionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def query_workflow_invocation_actions(name: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>
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).
- name (::String) — Required. The workflow invocation's name.
- page_size (::Integer) — Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
-
page_token (::String) — Optional. Page token received from a previous
QueryWorkflowInvocationActions
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
QueryWorkflowInvocationActions
must match the call that provided the page token.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::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::V1beta1::WorkflowInvocationAction. p item end
#read_file
def read_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReadFileResponse
def read_file(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::ReadFileResponse
Returns the contents of a file (inside a Workspace).
def read_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReadFileResponse
read_file
via a request object, either of type
ReadFileRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::ReadFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def read_file(workspace: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::ReadFileResponse
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).
- workspace (::String) — Required. The workspace's name.
- path (::String) — Required. The file's full path including filename, relative to the workspace root.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::ReadFileResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::ReadFileRequest.new # Call the read_file method. result = client.read_file request # The returned object is of type Google::Cloud::Dataform::V1beta1::ReadFileResponse. p result
#read_repository_file
def read_repository_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse
def read_repository_file(name: nil, commit_sha: nil, path: nil) -> ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse
Returns the contents of a file (inside a Repository). The Repository
must not have a value for git_remote_settings.url
.
def read_repository_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse
read_repository_file
via a request object, either of type
ReadRepositoryFileRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::V1beta1::ReadRepositoryFileResponse
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::ReadRepositoryFileRequest.new # Call the read_repository_file method. result = client.read_repository_file request # The returned object is of type Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse. p result
#remove_directory
def remove_directory(request, options = nil) -> ::Google::Protobuf::Empty
def remove_directory(workspace: nil, path: nil) -> ::Google::Protobuf::Empty
Deletes a directory (inside a Workspace) and all of its contents.
def remove_directory(request, options = nil) -> ::Google::Protobuf::Empty
remove_directory
via a request object, either of type
RemoveDirectoryRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def remove_directory(workspace: nil, path: nil) -> ::Google::Protobuf::Empty
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).
- workspace (::String) — Required. The workspace's name.
- path (::String) — Required. The directory's full path including directory name, relative to the workspace root.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest.new # Call the remove_directory method. result = client.remove_directory request # The returned object is of type Google::Protobuf::Empty. p result
#remove_file
def remove_file(request, options = nil) -> ::Google::Protobuf::Empty
def remove_file(workspace: nil, path: nil) -> ::Google::Protobuf::Empty
Deletes a file (inside a Workspace).
def remove_file(request, options = nil) -> ::Google::Protobuf::Empty
remove_file
via a request object, either of type
RemoveFileRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::RemoveFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def remove_file(workspace: nil, path: nil) -> ::Google::Protobuf::Empty
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).
- workspace (::String) — Required. The workspace's name.
- path (::String) — Required. The file's full path including filename, relative to the workspace root.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::RemoveFileRequest.new # Call the remove_file method. result = client.remove_file request # The returned object is of type Google::Protobuf::Empty. p result
#reset_workspace_changes
def reset_workspace_changes(request, options = nil) -> ::Google::Protobuf::Empty
def reset_workspace_changes(name: nil, paths: nil, clean: nil) -> ::Google::Protobuf::Empty
Performs a Git reset for uncommitted files in a Workspace.
def reset_workspace_changes(request, options = nil) -> ::Google::Protobuf::Empty
reset_workspace_changes
via a request object, either of type
ResetWorkspaceChangesRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def reset_workspace_changes(name: nil, paths: nil, clean: nil) -> ::Google::Protobuf::Empty
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).
- 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.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Protobuf::Empty)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest.new # Call the reset_workspace_changes method. result = client.reset_workspace_changes request # The returned object is of type Google::Protobuf::Empty. p result
#universe_domain
def universe_domain() -> String
The effective universe domain
- (String)
#update_release_config
def update_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
def update_release_config(update_mask: nil, release_config: nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
Updates a single ReleaseConfig.
def update_release_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::ReleaseConfig
update_release_config
via a request object, either of type
UpdateReleaseConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::V1beta1::ReleaseConfig
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).
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.
- release_config (::Google::Cloud::Dataform::V1beta1::ReleaseConfig, ::Hash) — Required. The release config to update.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::ReleaseConfig)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::UpdateReleaseConfigRequest.new # Call the update_release_config method. result = client.update_release_config request # The returned object is of type Google::Cloud::Dataform::V1beta1::ReleaseConfig. p result
#update_repository
def update_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
def update_repository(update_mask: nil, repository: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
Updates a single Repository.
def update_repository(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
update_repository
via a request object, either of type
UpdateRepositoryRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def update_repository(update_mask: nil, repository: nil) -> ::Google::Cloud::Dataform::V1beta1::Repository
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).
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
- repository (::Google::Cloud::Dataform::V1beta1::Repository, ::Hash) — Required. The repository to update.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::Repository)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest.new # Call the update_repository method. result = client.update_repository request # The returned object is of type Google::Cloud::Dataform::V1beta1::Repository. p result
#update_workflow_config
def update_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
def update_workflow_config(update_mask: nil, workflow_config: nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
Updates a single WorkflowConfig.
def update_workflow_config(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WorkflowConfig
update_workflow_config
via a request object, either of type
UpdateWorkflowConfigRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::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::V1beta1::WorkflowConfig
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).
- update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
- workflow_config (::Google::Cloud::Dataform::V1beta1::WorkflowConfig, ::Hash) — Required. The workflow config to update.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::WorkflowConfig)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::UpdateWorkflowConfigRequest.new # Call the update_workflow_config method. result = client.update_workflow_config request # The returned object is of type Google::Cloud::Dataform::V1beta1::WorkflowConfig. p result
#write_file
def write_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WriteFileResponse
def write_file(workspace: nil, path: nil, contents: nil) -> ::Google::Cloud::Dataform::V1beta1::WriteFileResponse
Writes to a file (inside a Workspace).
def write_file(request, options = nil) -> ::Google::Cloud::Dataform::V1beta1::WriteFileResponse
write_file
via a request object, either of type
WriteFileRequest or an equivalent Hash.
- request (::Google::Cloud::Dataform::V1beta1::WriteFileRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def write_file(workspace: nil, path: nil, contents: nil) -> ::Google::Cloud::Dataform::V1beta1::WriteFileResponse
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).
- workspace (::String) — Required. The workspace's name.
- path (::String) — Required. The file.
- contents (::String) — Required. The file's contents.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::Dataform::V1beta1::WriteFileResponse)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/dataform/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::Dataform::V1beta1::Dataform::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::Dataform::V1beta1::WriteFileRequest.new # Call the write_file method. result = client.write_file request # The returned object is of type Google::Cloud::Dataform::V1beta1::WriteFileResponse. p result