Class: Google::Cloud::Dataform::V1beta1::Dataform::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/dataform/v1beta1/dataform/client.rb

Overview

Client for the Dataform service.

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

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#compilation_result_path, #location_path, #release_config_path, #repository_path, #secret_version_path, #workflow_config_path, #workflow_invocation_path, #workspace_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Dataform client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the Dataform client.

Yield Parameters:



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 124

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/dataform/v1beta1/dataform_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @dataform_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Dataform::V1beta1::Dataform::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @dataform_stub.endpoint
    config.universe_domain = @dataform_stub.universe_domain
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @dataform_stub.endpoint
    config.universe_domain = @dataform_stub.universe_domain
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

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

Returns:

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


190
191
192
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 190

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

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

Returns:

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


183
184
185
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 183

def location_client
  @location_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Dataform Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Dataform clients
::Google::Cloud::Dataform::V1beta1::Dataform::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 62

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dataform", "V1beta1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#cancel_workflow_invocation(request, options = nil) ⇒ ::Google::Protobuf::Empty #cancel_workflow_invocation(name: nil) ⇒ ::Google::Protobuf::Empty

Requests cancellation of a running WorkflowInvocation.

Examples:

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

Overloads:

  • #cancel_workflow_invocation(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to cancel_workflow_invocation via a request object, either of type CancelWorkflowInvocationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #cancel_workflow_invocation(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to cancel_workflow_invocation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workflow invocation resource's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4713

def cancel_workflow_invocation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CancelWorkflowInvocationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_workflow_invocation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_workflow_invocation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_workflow_invocation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :cancel_workflow_invocation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#commit_repository_changes(request, options = nil) ⇒ ::Google::Protobuf::Empty #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.

Examples:

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

Overloads:

  • #commit_repository_changes(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to commit_repository_changes via a request object, either of type CommitRepositoryChangesRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #commit_repository_changes(name: nil, commit_metadata: nil, required_head_commit_sha: nil, file_operations: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to commit_repository_changes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The repository's name.

    • commit_metadata (::Google::Cloud::Dataform::V1beta1::CommitMetadata, ::Hash) (defaults to: nil) —

      Required. The changes to commit to the repository.

    • required_head_commit_sha (::String) (defaults to: nil) —

      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}) (defaults to: nil) —

      A map to the path of the file to the operation. The path is the full file path including filename, from repository root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 708

def commit_repository_changes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.commit_repository_changes.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.commit_repository_changes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.commit_repository_changes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :commit_repository_changes, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#commit_workspace_changes(request, options = nil) ⇒ ::Google::Protobuf::Empty #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.

Examples:

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

Overloads:

  • #commit_workspace_changes(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to commit_workspace_changes via a request object, either of type CommitWorkspaceChangesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #commit_workspace_changes(name: nil, author: nil, commit_message: nil, paths: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to commit_workspace_changes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workspace's name.

    • author (::Google::Cloud::Dataform::V1beta1::CommitAuthor, ::Hash) (defaults to: nil) —

      Required. The commit's author.

    • commit_message (::String) (defaults to: nil) —

      Optional. The commit's message.

    • paths (::Array<::String>) (defaults to: nil) —

      Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2078

def commit_workspace_changes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CommitWorkspaceChangesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.commit_workspace_changes.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.commit_workspace_changes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.commit_workspace_changes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :commit_workspace_changes, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#compute_repository_access_token_status(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusResponse #compute_repository_access_token_status(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusResponse

Computes a Repository's Git access token status.

Examples:

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1094

def compute_repository_access_token_status request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.compute_repository_access_token_status.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.compute_repository_access_token_status.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.compute_repository_access_token_status.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :compute_repository_access_token_status, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



94
95
96
97
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 94

def configure
  yield @config if block_given?
  @config
end

#create_compilation_result(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult #create_compilation_result(parent: nil, compilation_result: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult

Creates a new CompilationResult in a given project and location.

Examples:

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

Overloads:

  • #create_compilation_result(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult

    Pass arguments to create_compilation_result via a request object, either of type CreateCompilationResultRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::CreateCompilationResultRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_compilation_result(parent: nil, compilation_result: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult

    Pass arguments to create_compilation_result via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The compilation result to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3708

def create_compilation_result request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CreateCompilationResultRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_compilation_result.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_compilation_result.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_compilation_result.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :create_compilation_result, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig #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.

Examples:

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

Overloads:

  • #create_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

    Pass arguments to create_release_config via a request object, either of type CreateReleaseConfigRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_release_config(parent: nil, release_config: nil, release_config_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

    Pass arguments to create_release_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The release config to create.

    • release_config_id (::String) (defaults to: nil) —

      Required. The ID to use for the release config, which will become the final component of the release config's resource name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3261

def create_release_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CreateReleaseConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_release_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_release_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_release_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :create_release_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository #create_repository(parent: nil, repository: nil, repository_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

Creates a new Repository in a given project and location.

Examples:

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

Overloads:

  • #create_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

    Pass arguments to create_repository via a request object, either of type CreateRepositoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::CreateRepositoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_repository(parent: nil, repository: nil, repository_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

    Pass arguments to create_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The location in which to create the repository. Must be in the format projects/*/locations/*.

    • repository (::Google::Cloud::Dataform::V1beta1::Repository, ::Hash) (defaults to: nil) —

      Required. The repository to create.

    • repository_id (::String) (defaults to: nil) —

      Required. The ID to use for the repository, which will become the final component of the repository's resource name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 436

def create_repository request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CreateRepositoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_repository.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_repository.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_repository.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :create_repository, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig #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.

Examples:

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

Overloads:

  • #create_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

    Pass arguments to create_workflow_config via a request object, either of type CreateWorkflowConfigRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_workflow_config(parent: nil, workflow_config: nil, workflow_config_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

    Pass arguments to create_workflow_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The workflow config to create.

    • workflow_config_id (::String) (defaults to: nil) —

      Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4090

def create_workflow_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CreateWorkflowConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_workflow_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_workflow_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_workflow_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :create_workflow_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_workflow_invocation(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation #create_workflow_invocation(parent: nil, workflow_invocation: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

Creates a new WorkflowInvocation in a given Repository.

Examples:

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

Overloads:

  • #create_workflow_invocation(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

    Pass arguments to create_workflow_invocation via a request object, either of type CreateWorkflowInvocationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::CreateWorkflowInvocationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_workflow_invocation(parent: nil, workflow_invocation: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

    Pass arguments to create_workflow_invocation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The workflow invocation resource to create.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4543

def create_workflow_invocation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CreateWorkflowInvocationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_workflow_invocation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_workflow_invocation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_workflow_invocation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :create_workflow_invocation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_workspace(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace #create_workspace(parent: nil, workspace: nil, workspace_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace

Creates a new Workspace in a given Repository.

Examples:

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

Overloads:

  • #create_workspace(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace

    Pass arguments to create_workspace via a request object, either of type CreateWorkspaceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::CreateWorkspaceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_workspace(parent: nil, workspace: nil, workspace_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace

    Pass arguments to create_workspace via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The repository in which to create the workspace. Must be in the format projects/*/locations/*/repositories/*.

    • workspace (::Google::Cloud::Dataform::V1beta1::Workspace, ::Hash) (defaults to: nil) —

      Required. The workspace to create.

    • workspace_id (::String) (defaults to: nil) —

      Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1462

def create_workspace request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::CreateWorkspaceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_workspace.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_workspace.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_workspace.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :create_workspace, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_release_config(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_release_config(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a single ReleaseConfig.

Examples:

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

Overloads:

  • #delete_release_config(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_release_config via a request object, either of type Google::Cloud::Dataform::V1beta1::DeleteReleaseConfigRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_release_config(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_release_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The release config's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3434

def delete_release_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::DeleteReleaseConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_release_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_release_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_release_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :delete_release_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_repository(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_repository(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

Deletes a single Repository.

Examples:

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

Overloads:

  • #delete_repository(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_repository via a request object, either of type Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_repository(name: nil, force: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The repository's name.

    • force (::Boolean) (defaults to: nil) —

      If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 613

def delete_repository request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::DeleteRepositoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_repository.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_repository.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_repository.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :delete_repository, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_workflow_config(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_workflow_config(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a single WorkflowConfig.

Examples:

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

Overloads:

  • #delete_workflow_config(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_workflow_config via a request object, either of type Google::Cloud::Dataform::V1beta1::DeleteWorkflowConfigRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_workflow_config(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_workflow_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workflow config's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4263

def delete_workflow_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::DeleteWorkflowConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_workflow_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_workflow_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_workflow_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :delete_workflow_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_workflow_invocation(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_workflow_invocation(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a single WorkflowInvocation.

Examples:

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

Overloads:

  • #delete_workflow_invocation(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_workflow_invocation via a request object, either of type Google::Cloud::Dataform::V1beta1::DeleteWorkflowInvocationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::DeleteWorkflowInvocationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_workflow_invocation(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_workflow_invocation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workflow invocation resource's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4628

def delete_workflow_invocation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::DeleteWorkflowInvocationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_workflow_invocation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_workflow_invocation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_workflow_invocation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :delete_workflow_invocation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_workspace(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_workspace(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a single Workspace.

Examples:

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

Overloads:

  • #delete_workspace(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_workspace via a request object, either of type Google::Cloud::Dataform::V1beta1::DeleteWorkspaceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::DeleteWorkspaceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_workspace(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_workspace via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workspace resource's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1547

def delete_workspace request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::DeleteWorkspaceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_workspace.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_workspace.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_workspace.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :delete_workspace, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_file_diff(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse #fetch_file_diff(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse

Fetches Git diff for an uncommitted file in a Workspace.

Examples:

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

Overloads:

  • #fetch_file_diff(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse

    Pass arguments to fetch_file_diff via a request object, either of type FetchFileDiffRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::FetchFileDiffRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #fetch_file_diff(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse

    Pass arguments to fetch_file_diff via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The file's full path including filename, relative to the workspace root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2256

def fetch_file_diff request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::FetchFileDiffRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.fetch_file_diff.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.fetch_file_diff.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_file_diff.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :fetch_file_diff, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_file_git_statuses(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse #fetch_file_git_statuses(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse

Fetches Git statuses for the files in a Workspace.

Examples:

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1897

def fetch_file_git_statuses request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.fetch_file_git_statuses.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.fetch_file_git_statuses.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_file_git_statuses.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :fetch_file_git_statuses, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_git_ahead_behind(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse #fetch_git_ahead_behind(name: nil, remote_branch: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse

Fetches Git ahead/behind against a remote branch.

Examples:

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

Overloads:

  • #fetch_git_ahead_behind(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse

    Pass arguments to fetch_git_ahead_behind via a request object, either of type FetchGitAheadBehindRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #fetch_git_ahead_behind(name: nil, remote_branch: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse

    Pass arguments to fetch_git_ahead_behind via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workspace's name.

    • remote_branch (::String) (defaults to: nil) —

      Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1986

def fetch_git_ahead_behind request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.fetch_git_ahead_behind.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.fetch_git_ahead_behind.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_git_ahead_behind.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :fetch_git_ahead_behind, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_remote_branches(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse #fetch_remote_branches(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse

Fetches a Repository's remote branches.

Examples:

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1179

def fetch_remote_branches request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.fetch_remote_branches.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.fetch_remote_branches.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_remote_branches.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :fetch_remote_branches, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#fetch_repository_history(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry> #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.

Examples:

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

Overloads:

  • #fetch_repository_history(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>

    Pass arguments to fetch_repository_history via a request object, either of type FetchRepositoryHistoryRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #fetch_repository_history(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>

    Pass arguments to fetch_repository_history via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The repository's name.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1008

def fetch_repository_history request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::FetchRepositoryHistoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.fetch_repository_history.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.fetch_repository_history.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.fetch_repository_history.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :fetch_repository_history, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :fetch_repository_history, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_compilation_result(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult #get_compilation_result(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult

Fetches a single CompilationResult.

Examples:

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

Overloads:

  • #get_compilation_result(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult

    Pass arguments to get_compilation_result via a request object, either of type GetCompilationResultRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::GetCompilationResultRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_compilation_result(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult

    Pass arguments to get_compilation_result via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The compilation result's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3620

def get_compilation_result request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::GetCompilationResultRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_compilation_result.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_compilation_result.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_compilation_result.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :get_compilation_result, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig #get_release_config(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

Fetches a single ReleaseConfig.

Examples:

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

Overloads:

  • #get_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

    Pass arguments to get_release_config via a request object, either of type GetReleaseConfigRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_release_config(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

    Pass arguments to get_release_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The release config's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3170

def get_release_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::GetReleaseConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_release_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_release_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_release_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :get_release_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository #get_repository(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

Fetches a single Repository.

Examples:

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

Overloads:

  • #get_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

    Pass arguments to get_repository via a request object, either of type GetRepositoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::GetRepositoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_repository(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

    Pass arguments to get_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The repository's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 345

def get_repository request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::GetRepositoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_repository.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_repository.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_repository.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :get_repository, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig #get_workflow_config(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

Fetches a single WorkflowConfig.

Examples:

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

Overloads:

  • #get_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

    Pass arguments to get_workflow_config via a request object, either of type GetWorkflowConfigRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_workflow_config(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

    Pass arguments to get_workflow_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workflow config's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3999

def get_workflow_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::GetWorkflowConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_workflow_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_workflow_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_workflow_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :get_workflow_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_workflow_invocation(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation #get_workflow_invocation(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

Fetches a single WorkflowInvocation.

Examples:

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

Overloads:

  • #get_workflow_invocation(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

    Pass arguments to get_workflow_invocation via a request object, either of type GetWorkflowInvocationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::GetWorkflowInvocationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_workflow_invocation(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

    Pass arguments to get_workflow_invocation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workflow invocation resource's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4455

def get_workflow_invocation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::GetWorkflowInvocationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_workflow_invocation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_workflow_invocation.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_workflow_invocation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :get_workflow_invocation, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_workspace(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace #get_workspace(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace

Fetches a single Workspace.

Examples:

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

Overloads:

  • #get_workspace(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace

    Pass arguments to get_workspace via a request object, either of type GetWorkspaceRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::GetWorkspaceRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_workspace(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace

    Pass arguments to get_workspace via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workspace's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1371

def get_workspace request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::GetWorkspaceRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_workspace.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_workspace.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_workspace.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :get_workspace, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#install_npm_packages(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse #install_npm_packages(workspace: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse

Installs dependency NPM packages (inside a Workspace).

Examples:

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

Overloads:

  • #install_npm_packages(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse

    Pass arguments to install_npm_packages via a request object, either of type InstallNpmPackagesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #install_npm_packages(workspace: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse

    Pass arguments to install_npm_packages via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1632

def install_npm_packages request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.install_npm_packages.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.install_npm_packages.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.install_npm_packages.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :install_npm_packages, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_compilation_results(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult> #list_compilation_results(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>

Lists CompilationResults in a given Repository.

Examples:

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

Overloads:

  • #list_compilation_results(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>

    Pass arguments to list_compilation_results via a request object, either of type ListCompilationResultsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::ListCompilationResultsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_compilation_results(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResult>

    Pass arguments to list_compilation_results via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The repository in which to list compilation results. Must be in the format projects/*/locations/*/repositories/*.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Page token received from a previous ListCompilationResults call. Provide this to retrieve the subsequent page.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3534

def list_compilation_results request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_compilation_results.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_compilation_results.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_compilation_results.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :list_compilation_results, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :list_compilation_results, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_release_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig> #list_release_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>

Lists ReleaseConfigs in a given Repository.

Examples:

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

Overloads:

  • #list_release_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>

    Pass arguments to list_release_configs via a request object, either of type ListReleaseConfigsRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_release_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::ReleaseConfig>

    Pass arguments to list_release_configs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The repository in which to list release configs. Must be in the format projects/*/locations/*/repositories/*.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3084

def list_release_configs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ListReleaseConfigsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_release_configs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_release_configs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_release_configs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :list_release_configs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :list_release_configs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_repositories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository> #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.

Examples:

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

Overloads:

  • #list_repositories(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>

    Pass arguments to list_repositories via a request object, either of type ListRepositoriesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::ListRepositoriesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_repositories(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Repository>

    Pass arguments to list_repositories via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The location in which to list repositories. Must be in the format projects/*/locations/*.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

    • filter (::String) (defaults to: nil) —

      Optional. Filter for the returned list.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 259

def list_repositories request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ListRepositoriesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_repositories.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_repositories.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_repositories.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :list_repositories, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :list_repositories, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workflow_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig> #list_workflow_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>

Lists WorkflowConfigs in a given Repository.

Examples:

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

Overloads:

  • #list_workflow_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>

    Pass arguments to list_workflow_configs via a request object, either of type ListWorkflowConfigsRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_workflow_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowConfig>

    Pass arguments to list_workflow_configs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The repository in which to list workflow configs. Must be in the format projects/*/locations/*/repositories/*.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3913

def list_workflow_configs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ListWorkflowConfigsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_workflow_configs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_workflow_configs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_workflow_configs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :list_workflow_configs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :list_workflow_configs, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workflow_invocations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation> #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.

Examples:

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

Overloads:

  • #list_workflow_invocations(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>

    Pass arguments to list_workflow_invocations via a request object, either of type ListWorkflowInvocationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_workflow_invocations(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocation>

    Pass arguments to list_workflow_invocations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent resource of the WorkflowInvocation type. Must be in the format projects/*/locations/*/repositories/*.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

    • filter (::String) (defaults to: nil) —

      Optional. Filter for the returned list.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4369

def list_workflow_invocations request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_workflow_invocations.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_workflow_invocations.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_workflow_invocations.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :list_workflow_invocations, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :list_workflow_invocations, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workspaces(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace> #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.

Examples:

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

Overloads:

  • #list_workspaces(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>

    Pass arguments to list_workspaces via a request object, either of type ListWorkspacesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::ListWorkspacesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_workspaces(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::Workspace>

    Pass arguments to list_workspaces via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The repository in which to list workspaces. Must be in the format projects/*/locations/*/repositories/*.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. This field only supports ordering by name. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the name field.

    • filter (::String) (defaults to: nil) —

      Optional. Filter for the returned list.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1285

def list_workspaces request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ListWorkspacesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_workspaces.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_workspaces.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_workspaces.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :list_workspaces, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :list_workspaces, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#make_directory(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse #make_directory(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse

Creates a directory inside a Workspace.

Examples:

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

Overloads:

  • #make_directory(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse

    Pass arguments to make_directory via a request object, either of type MakeDirectoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::MakeDirectoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #make_directory(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MakeDirectoryResponse

    Pass arguments to make_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The directory's full path including directory name, relative to the workspace root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2448

def make_directory request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::MakeDirectoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.make_directory.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.make_directory.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.make_directory.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :make_directory, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#move_directory(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse #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.

Examples:

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

Overloads:

  • #move_directory(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse

    Pass arguments to move_directory via a request object, either of type MoveDirectoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::MoveDirectoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #move_directory(workspace: nil, path: nil, new_path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse

    Pass arguments to move_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The directory's full path including directory name, relative to the workspace root.

    • new_path (::String) (defaults to: nil) —

      Required. The new path for the directory including directory name, rooted at workspace root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2628

def move_directory request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::MoveDirectoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.move_directory.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.move_directory.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.move_directory.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :move_directory, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#move_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveFileResponse #move_file(workspace: nil, path: nil, new_path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveFileResponse

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

Examples:

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

Overloads:

  • #move_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveFileResponse

    Pass arguments to move_file via a request object, either of type MoveFileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::MoveFileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #move_file(workspace: nil, path: nil, new_path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveFileResponse

    Pass arguments to move_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The file's full path including filename, relative to the workspace root.

    • new_path (::String) (defaults to: nil) —

      Required. The file's new path including filename, relative to the workspace root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2895

def move_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::MoveFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.move_file.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.move_file.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.move_file.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :move_file, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#pull_git_commits(request, options = nil) ⇒ ::Google::Protobuf::Empty #pull_git_commits(name: nil, remote_branch: nil, author: nil) ⇒ ::Google::Protobuf::Empty

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

Examples:

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

Overloads:

  • #pull_git_commits(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to pull_git_commits via a request object, either of type PullGitCommitsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::PullGitCommitsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #pull_git_commits(name: nil, remote_branch: nil, author: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to pull_git_commits via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workspace's name.

    • remote_branch (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1723

def pull_git_commits request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::PullGitCommitsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.pull_git_commits.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.pull_git_commits.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.pull_git_commits.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :pull_git_commits, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#push_git_commits(request, options = nil) ⇒ ::Google::Protobuf::Empty #push_git_commits(name: nil, remote_branch: nil) ⇒ ::Google::Protobuf::Empty

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

Examples:

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

Overloads:

  • #push_git_commits(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to push_git_commits via a request object, either of type PushGitCommitsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::PushGitCommitsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #push_git_commits(name: nil, remote_branch: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to push_git_commits via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workspace's name.

    • remote_branch (::String) (defaults to: nil) —

      Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 1812

def push_git_commits request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::PushGitCommitsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.push_git_commits.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.push_git_commits.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.push_git_commits.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :push_git_commits, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#query_compilation_result_actions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction> #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.

Examples:

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

Overloads:

  • #query_compilation_result_actions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>

    Pass arguments to query_compilation_result_actions via a request object, either of type QueryCompilationResultActionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::QueryCompilationResultActionsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #query_compilation_result_actions(name: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>

    Pass arguments to query_compilation_result_actions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The compilation result's name.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Optional filter for the returned list. Filtering is only currently supported on the file_path field.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3812

def query_compilation_result_actions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::QueryCompilationResultActionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.query_compilation_result_actions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.query_compilation_result_actions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.query_compilation_result_actions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :query_compilation_result_actions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :query_compilation_result_actions, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#query_directory_contents(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry> #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.

Examples:

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

Overloads:

  • #query_directory_contents(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

    Pass arguments to query_directory_contents via a request object, either of type QueryDirectoryContentsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

    Pass arguments to query_directory_contents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Page token received from a previous QueryDirectoryContents call. Provide this to retrieve the subsequent page.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2359

def query_directory_contents request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::QueryDirectoryContentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.query_directory_contents.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.query_directory_contents.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.query_directory_contents.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :query_directory_contents, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :query_directory_contents, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#query_repository_directory_contents(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry> #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.

Examples:

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

Overloads:

  • #query_repository_directory_contents(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

    Pass arguments to query_repository_directory_contents via a request object, either of type QueryRepositoryDirectoryContentsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #query_repository_directory_contents(name: nil, commit_sha: nil, path: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

    Pass arguments to query_repository_directory_contents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The repository's name.

    • commit_sha (::String) (defaults to: nil) —

      Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.

    • path (::String) (defaults to: nil) —

      Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 907

def query_repository_directory_contents request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::QueryRepositoryDirectoryContentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.query_repository_directory_contents.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.query_repository_directory_contents.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.query_repository_directory_contents.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :query_repository_directory_contents, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :query_repository_directory_contents, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#query_workflow_invocation_actions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction> #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.

Examples:

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

Overloads:

  • #query_workflow_invocation_actions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>

    Pass arguments to query_workflow_invocation_actions via a request object, either of type QueryWorkflowInvocationActionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::QueryWorkflowInvocationActionsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #query_workflow_invocation_actions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>

    Pass arguments to query_workflow_invocation_actions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workflow invocation's name.

    • page_size (::Integer) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. Page token received from a previous QueryWorkflowInvocationActions call. Provide this to retrieve the subsequent page.

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4814

def query_workflow_invocation_actions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::QueryWorkflowInvocationActionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.query_workflow_invocation_actions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.query_workflow_invocation_actions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.query_workflow_invocation_actions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :query_workflow_invocation_actions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @dataform_stub, :query_workflow_invocation_actions, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#read_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadFileResponse #read_file(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadFileResponse

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

Examples:

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

Overloads:

  • #read_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadFileResponse

    Pass arguments to read_file via a request object, either of type ReadFileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::ReadFileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #read_file(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadFileResponse

    Pass arguments to read_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The file's full path including filename, relative to the workspace root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2716

def read_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ReadFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.read_file.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.read_file.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.read_file.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :read_file, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#read_repository_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse #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.

Examples:

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

Overloads:

  • #read_repository_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse

    Pass arguments to read_repository_file via a request object, either of type ReadRepositoryFileRequest or an equivalent Hash.

    Parameters:

    • 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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #read_repository_file(name: nil, commit_sha: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse

    Pass arguments to read_repository_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The repository's name.

    • commit_sha (::String) (defaults to: nil) —

      Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.

    • path (::String) (defaults to: nil) —

      Required. Full file path to read including filename, from repository root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 799

def read_repository_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.read_repository_file.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.read_repository_file.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.read_repository_file.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :read_repository_file, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#remove_directory(request, options = nil) ⇒ ::Google::Protobuf::Empty #remove_directory(workspace: nil, path: nil) ⇒ ::Google::Protobuf::Empty

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

Examples:

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

Overloads:

  • #remove_directory(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_directory via a request object, either of type RemoveDirectoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #remove_directory(workspace: nil, path: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The directory's full path including directory name, relative to the workspace root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2536

def remove_directory request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.remove_directory.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.remove_directory.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.remove_directory.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :remove_directory, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#remove_file(request, options = nil) ⇒ ::Google::Protobuf::Empty #remove_file(workspace: nil, path: nil) ⇒ ::Google::Protobuf::Empty

Deletes a file (inside a Workspace).

Examples:

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

Overloads:

  • #remove_file(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_file via a request object, either of type RemoveFileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::RemoveFileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #remove_file(workspace: nil, path: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The file's full path including filename, relative to the workspace root.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2804

def remove_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::RemoveFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.remove_file.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.remove_file.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.remove_file.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :remove_file, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reset_workspace_changes(request, options = nil) ⇒ ::Google::Protobuf::Empty #reset_workspace_changes(name: nil, paths: nil, clean: nil) ⇒ ::Google::Protobuf::Empty

Performs a Git reset for uncommitted files in a Workspace.

Examples:

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

Overloads:

  • #reset_workspace_changes(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to reset_workspace_changes via a request object, either of type ResetWorkspaceChangesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #reset_workspace_changes(name: nil, paths: nil, clean: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to reset_workspace_changes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workspace's name.

    • paths (::Array<::String>) (defaults to: nil) —

      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) (defaults to: nil) —

      Optional. If set to true, untracked files will be deleted.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2168

def reset_workspace_changes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.reset_workspace_changes.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.reset_workspace_changes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.reset_workspace_changes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :reset_workspace_changes, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


104
105
106
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 104

def universe_domain
  @dataform_stub.universe_domain
end

#update_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig #update_release_config(update_mask: nil, release_config: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

Updates a single ReleaseConfig.

Examples:

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 3349

def update_release_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::UpdateReleaseConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_release_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.release_config&.name
    header_params["release_config.name"] = request.release_config.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_release_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_release_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :update_release_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository #update_repository(update_mask: nil, repository: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

Updates a single Repository.

Examples:

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

Overloads:

  • #update_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

    Pass arguments to update_repository via a request object, either of type UpdateRepositoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_repository(update_mask: nil, repository: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

    Pass arguments to update_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 524

def update_repository request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_repository.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.repository&.name
    header_params["repository.name"] = request.repository.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_repository.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_repository.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :update_repository, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig #update_workflow_config(update_mask: nil, workflow_config: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

Updates a single WorkflowConfig.

Examples:

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 4178

def update_workflow_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::UpdateWorkflowConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_workflow_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workflow_config&.name
    header_params["workflow_config.name"] = request.workflow_config.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_workflow_config.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_workflow_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :update_workflow_config, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#write_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WriteFileResponse #write_file(workspace: nil, path: nil, contents: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WriteFileResponse

Writes to a file (inside a Workspace).

Examples:

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

Overloads:

  • #write_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WriteFileResponse

    Pass arguments to write_file via a request object, either of type WriteFileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::WriteFileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #write_file(workspace: nil, path: nil, contents: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WriteFileResponse

    Pass arguments to write_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The file.

    • contents (::String) (defaults to: nil) —

      Required. The file's contents.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/client.rb', line 2984

def write_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::WriteFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.write_file.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Dataform::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.workspace
    header_params["workspace"] = request.workspace
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.write_file.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.write_file.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.call_rpc :write_file, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end