Class: Google::Cloud::Dataform::V1::Dataform::Rest::Client

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

Overview

REST 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, #config_path, #crypto_key_path, #crypto_key_version_path, #folder_path, #location_path, #notebook_runtime_template_path, #release_config_path, #repository_path, #secret_version_path, #team_folder_path, #workflow_config_path, #workflow_invocation_path, #workspace_path

Constructor Details

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

Create a new Dataform REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

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

Yields:

  • (config) —

    Configure the Dataform client.

Yield Parameters:



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 129

def initialize
  # 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

  @operations_client = ::Google::Cloud::Dataform::V1::Dataform::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @dataform_stub = ::Google::Cloud::Dataform::V1::Dataform::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @dataform_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::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
    config.bindings_override = @config.bindings_override
    config.logger = @dataform_stub.logger if config.respond_to? :logger=
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::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
    config.logger = @dataform_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

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

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

Returns:

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


214
215
216
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 214

def iam_policy_client
  @iam_policy_client
end

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

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

Returns:

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


207
208
209
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 207

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::Dataform::V1::Dataform::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



200
201
202
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 200

def operations_client
  @operations_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::V1::Dataform::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 67

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Dataform", "V1"]
    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::Cloud::Dataform::V1::CancelWorkflowInvocationResponse #cancel_workflow_invocation(name: nil) ⇒ ::Google::Cloud::Dataform::V1::CancelWorkflowInvocationResponse

Requests cancellation of a running WorkflowInvocation.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #cancel_workflow_invocation(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::CancelWorkflowInvocationResponse

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

    Parameters:

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

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

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

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

  • #cancel_workflow_invocation(name: nil) ⇒ ::Google::Cloud::Dataform::V1::CancelWorkflowInvocationResponse

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

    Parameters:

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

      Required. The workflow invocation resource's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 6009

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::V1::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
  call_metadata = @config.rpcs.cancel_workflow_invocation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.cancel_workflow_invocation.timeout,
                         metadata:     call_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.cancel_workflow_invocation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#commit_repository_changes(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::CommitRepositoryChangesResponse #commit_repository_changes(name: nil, commit_metadata: nil, required_head_commit_sha: nil, file_operations: nil) ⇒ ::Google::Cloud::Dataform::V1::CommitRepositoryChangesResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #commit_repository_changes(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::CommitRepositoryChangesResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::CommitRepositoryChangesRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Cloud::Dataform::V1::CommitRepositoryChangesResponse

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

    Parameters:

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

      Required. The repository's name.

    • commit_metadata (::Google::Cloud::Dataform::V1::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::V1::CommitRepositoryChangesRequest::FileOperation, ::Hash}) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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/v1/dataform/rest/client.rb', line 2174

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::V1::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
  call_metadata = @config.rpcs.commit_repository_changes.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.commit_repository_changes.timeout,
                         metadata:     call_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.commit_repository_changes request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#commit_workspace_changes(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::CommitWorkspaceChangesResponse #commit_workspace_changes(name: nil, author: nil, commit_message: nil, paths: nil) ⇒ ::Google::Cloud::Dataform::V1::CommitWorkspaceChangesResponse

Applies a Git commit for uncommitted files in a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #commit_workspace_changes(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::CommitWorkspaceChangesResponse

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::Cloud::Dataform::V1::CommitWorkspaceChangesResponse

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

    Parameters:

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

      Required. The workspace's name.

    • author (::Google::Cloud::Dataform::V1::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
3474
3475
3476
3477
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3444

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::V1::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
  call_metadata = @config.rpcs.commit_workspace_changes.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.commit_workspace_changes.timeout,
                         metadata:     call_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.commit_workspace_changes request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Computes a Repository's Git access token status.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2535
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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2535

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::V1::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
  call_metadata = @config.rpcs.compute_repository_access_token_status.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.compute_repository_access_token_status.timeout,
                         metadata:     call_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.compute_repository_access_token_status request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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:



99
100
101
102
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 99

def configure
  yield @config if block_given?
  @config
end

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

Creates a new CompilationResult in a given project and location.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::CompilationResult

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

    Parameters:

    • parent (::String) (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::V1::CompilationResult, ::Hash) (defaults to: nil) —

      Required. The compilation result to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5071

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::V1::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
  call_metadata = @config.rpcs.create_compilation_result.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_compilation_result.timeout,
                         metadata:     call_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.create_compilation_result request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Folder #create_folder(parent: nil, folder: nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

Creates a new Folder in a given project and location.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #create_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::CreateFolderRequest, ::Hash) —

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

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

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

  • #create_folder(parent: nil, folder: nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

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

    Parameters:

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

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

    • folder (::Google::Cloud::Dataform::V1::Folder, ::Hash) (defaults to: nil) —

      Required. The Folder to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 985

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::CreateFolderRequest

  # 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
  call_metadata = @config.rpcs.create_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_folder.retry_policy

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

  @dataform_stub.create_folder request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ReleaseConfig #create_release_config(parent: nil, release_config: nil, release_config_id: nil) ⇒ ::Google::Cloud::Dataform::V1::ReleaseConfig

Creates a new ReleaseConfig in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::CreateReleaseConfigRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::ReleaseConfig

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

    Parameters:

    • parent (::String) (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::V1::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4646

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::V1::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
  call_metadata = @config.rpcs.create_release_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_release_config.timeout,
                         metadata:     call_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.create_release_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Creates a new Repository in a given project and location.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::Repository

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

    Parameters:

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

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

    • repository (::Google::Cloud::Dataform::V1::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
1852
1853
1854
1855
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1822

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.create_repository.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_repository.timeout,
                         metadata:     call_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.create_repository request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_team_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder #create_team_folder(parent: nil, team_folder: nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

Creates a new TeamFolder in a given project and location.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #create_team_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::CreateTeamFolderRequest, ::Hash) —

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

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

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

  • #create_team_folder(parent: nil, team_folder: nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

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

    Parameters:

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

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

    • team_folder (::Google::Cloud::Dataform::V1::TeamFolder, ::Hash) (defaults to: nil) —

      Required. The TeamFolder to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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/v1/dataform/rest/client.rb', line 351

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::CreateTeamFolderRequest

  # 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
  call_metadata = @config.rpcs.create_team_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_team_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_team_folder.retry_policy

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

  @dataform_stub.create_team_folder request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::WorkflowConfig #create_workflow_config(parent: nil, workflow_config: nil, workflow_config_id: nil) ⇒ ::Google::Cloud::Dataform::V1::WorkflowConfig

Creates a new WorkflowConfig in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::CreateWorkflowConfigRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::WorkflowConfig

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

    Parameters:

    • parent (::String) (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::V1::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5428

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::V1::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
  call_metadata = @config.rpcs.create_workflow_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_workflow_config.timeout,
                         metadata:     call_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.create_workflow_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Creates a new WorkflowInvocation in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::WorkflowInvocation

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

    Parameters:

    • parent (::String) (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::V1::WorkflowInvocation, ::Hash) (defaults to: nil) —

      Required. The workflow invocation resource to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5853

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::V1::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
  call_metadata = @config.rpcs.create_workflow_invocation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_workflow_invocation.timeout,
                         metadata:     call_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.create_workflow_invocation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Creates a new Workspace in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::Workspace

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

    Parameters:

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

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

    • workspace (::Google::Cloud::Dataform::V1::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2877

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.create_workspace.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_workspace.timeout,
                         metadata:     call_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.create_workspace request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a single Folder.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

    Pass arguments to delete_folder via a request object, either of type Google::Cloud::Dataform::V1::DeleteFolderRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::DeleteFolderRequest, ::Hash) —

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

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

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

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

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

    Parameters:

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

      Required. The Folder's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1146

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteFolderRequest

  # 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
  call_metadata = @config.rpcs.delete_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_folder.retry_policy

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

  @dataform_stub.delete_folder request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_folder_tree(request, options = nil) ⇒ ::Gapic::Operation #delete_folder_tree(name: nil, force: nil) ⇒ ::Gapic::Operation

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #delete_folder_tree(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_folder_tree via a request object, either of type Google::Cloud::Dataform::V1::DeleteFolderTreeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::DeleteFolderTreeRequest, ::Hash) —

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

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

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

  • #delete_folder_tree(name: nil, force: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. The Folder's name. Format: projects/{project}/locations/{location}/folders/{folder}

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

      Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1241

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteFolderTreeRequest

  # 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
  call_metadata = @config.rpcs.delete_folder_tree.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_folder_tree.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_folder_tree.retry_policy

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

  @dataform_stub.delete_folder_tree request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => 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/v1"

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

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

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

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

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::V1::DeleteReleaseConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::DeleteReleaseConfigRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4810
4811
4812
4813
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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4810

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::V1::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
  call_metadata = @config.rpcs.delete_release_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_release_config.timeout,
                         metadata:     call_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.delete_release_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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) —

      Optional. If set to true, child resources of this repository (compilation results and workflow invocations) will also be deleted. Otherwise, the request will only succeed if the repository has no child resources.

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
2026
2027
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1994

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.delete_repository.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_repository.timeout,
                         metadata:     call_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.delete_repository request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a single TeamFolder.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

    Pass arguments to delete_team_folder via a request object, either of type Google::Cloud::Dataform::V1::DeleteTeamFolderRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::DeleteTeamFolderRequest, ::Hash) —

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

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

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

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

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

    Parameters:

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

      Required. The TeamFolder's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 510

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteTeamFolderRequest

  # 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
  call_metadata = @config.rpcs.delete_team_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_team_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_team_folder.retry_policy

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

  @dataform_stub.delete_team_folder request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_team_folder_tree(request, options = nil) ⇒ ::Gapic::Operation #delete_team_folder_tree(name: nil, force: nil) ⇒ ::Gapic::Operation

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #delete_team_folder_tree(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_team_folder_tree via a request object, either of type Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest, ::Hash) —

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

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

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

  • #delete_team_folder_tree(name: nil, force: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. The TeamFolder's name. Format: projects/{project}/locations/{location}/teamFolders/{team_folder}

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

      Optional. If false (default): The operation will fail if any Repository within the folder hierarchy has associated Release Configs or Workflow Configs.

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



605
606
607
608
609
610
611
612
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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 605

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::DeleteTeamFolderTreeRequest

  # 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
  call_metadata = @config.rpcs.delete_team_folder_tree.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_team_folder_tree.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_team_folder_tree.retry_policy

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

  @dataform_stub.delete_team_folder_tree request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => 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/v1"

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

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

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

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

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::V1::DeleteWorkflowConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::DeleteWorkflowConfigRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5592

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::V1::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
  call_metadata = @config.rpcs.delete_workflow_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_workflow_config.timeout,
                         metadata:     call_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.delete_workflow_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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/v1"

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

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

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

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

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::V1::DeleteWorkflowInvocationRequest or an equivalent Hash.

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5931

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::V1::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
  call_metadata = @config.rpcs.delete_workflow_invocation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_workflow_invocation.timeout,
                         metadata:     call_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.delete_workflow_invocation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => 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/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2955

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.delete_workspace.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_workspace.timeout,
                         metadata:     call_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.delete_workspace request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches Git diff for an uncommitted file in a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::FetchFileDiffResponse

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

    Parameters:

    • workspace (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3608

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::V1::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
  call_metadata = @config.rpcs.fetch_file_diff.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_file_diff.timeout,
                         metadata:     call_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.fetch_file_diff request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches Git statuses for the files in a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #fetch_file_git_statuses(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::FetchFileGitStatusesResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::FetchFileGitStatusesRequest, ::Hash) —

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

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

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

  • #fetch_file_git_statuses(name: nil) ⇒ ::Google::Cloud::Dataform::V1::FetchFileGitStatusesResponse

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

    Parameters:

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

      Required. The workspace's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3277

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::V1::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
  call_metadata = @config.rpcs.fetch_file_git_statuses.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_file_git_statuses.timeout,
                         metadata:     call_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.fetch_file_git_statuses request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches Git ahead/behind against a remote branch.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::FetchGitAheadBehindResponse

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

    Parameters:

    • name (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
3389
3390
3391
3392
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3359

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::V1::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
  call_metadata = @config.rpcs.fetch_git_ahead_behind.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_git_ahead_behind.timeout,
                         metadata:     call_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.fetch_git_ahead_behind request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches a Repository's remote branches.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #fetch_remote_branches(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::FetchRemoteBranchesResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::FetchRemoteBranchesRequest, ::Hash) —

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

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

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

  • #fetch_remote_branches(name: nil) ⇒ ::Google::Cloud::Dataform::V1::FetchRemoteBranchesResponse

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

    Parameters:

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

      Required. The repository's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2613

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::V1::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
  call_metadata = @config.rpcs.fetch_remote_branches.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_remote_branches.timeout,
                         metadata:     call_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.fetch_remote_branches request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::FetchRepositoryHistoryRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CommitLogEntry>

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

    Parameters:

    • name (::String) (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, with the exception of page_size, must match the call that provided the page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
2488
2489
2490
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2455

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::V1::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
  call_metadata = @config.rpcs.fetch_repository_history.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.fetch_repository_history.timeout,
                         metadata:     call_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.fetch_repository_history request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :fetch_repository_history, "commits", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches a single CompilationResult.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The compilation result's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4990

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::V1::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
  call_metadata = @config.rpcs.get_compilation_result.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_compilation_result.timeout,
                         metadata:     call_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.get_compilation_result request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Config #get_config(name: nil) ⇒ ::Google::Cloud::Dataform::V1::Config

Get default config for a given project and location.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #get_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Config

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::GetConfigRequest, ::Hash) —

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

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

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

  • #get_config(name: nil) ⇒ ::Google::Cloud::Dataform::V1::Config

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

    Parameters:

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

      Required. The config name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 6183

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::GetConfigRequest

  # 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
  call_metadata = @config.rpcs.get_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_config.retry_policy

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

  @dataform_stub.get_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Folder #get_folder(name: nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

Fetches a single Folder.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #get_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::GetFolderRequest, ::Hash) —

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

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

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

  • #get_folder(name: nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

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

    Parameters:

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

      Required. The Folder's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



904
905
906
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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 904

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::GetFolderRequest

  # 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
  call_metadata = @config.rpcs.get_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_folder.retry_policy

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

  @dataform_stub.get_folder request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #get_iam_policy(resource: nil, options: nil) ⇒ ::Google::Iam::V1::Policy

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #get_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy

    Pass arguments to get_iam_policy via a request object, either of type Iam::V1::GetIamPolicyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Iam::V1::GetIamPolicyRequest, ::Hash) —

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

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

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

  • #get_iam_policy(resource: nil, options: nil) ⇒ ::Google::Iam::V1::Policy

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

    Parameters:

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

      REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

    • options (::Google::Iam::V1::GetPolicyOptions, ::Hash) (defaults to: nil) —

      OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Google::Iam::V1::Policy)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Google::Iam::V1::Policy)

Raises:

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

    if the REST call is aborted.



6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 6352

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::GetIamPolicyRequest

  # 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
  call_metadata = @config.rpcs.get_iam_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_iam_policy.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_iam_policy.retry_policy

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

  @dataform_stub.get_iam_policy request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches a single ReleaseConfig.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::GetReleaseConfigRequest, ::Hash) —

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

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

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

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

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

    Parameters:

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

      Required. The release config's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4562

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::V1::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
  call_metadata = @config.rpcs.get_release_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_release_config.timeout,
                         metadata:     call_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.get_release_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches a single Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The repository's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
1763
1764
1765
1766
1767
1768
1769
1770
1771
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1738

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.get_repository.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_repository.timeout,
                         metadata:     call_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.get_repository request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_team_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder #get_team_folder(name: nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

Fetches a single TeamFolder.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #get_team_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::GetTeamFolderRequest, ::Hash) —

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

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

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

  • #get_team_folder(name: nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

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

    Parameters:

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

      Required. The TeamFolder's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
300
301
302
303
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 270

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::GetTeamFolderRequest

  # 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
  call_metadata = @config.rpcs.get_team_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_team_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_team_folder.retry_policy

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

  @dataform_stub.get_team_folder request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches a single WorkflowConfig.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::GetWorkflowConfigRequest, ::Hash) —

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

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

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

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

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

    Parameters:

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

      Required. The workflow config's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5344

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::V1::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
  call_metadata = @config.rpcs.get_workflow_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_workflow_config.timeout,
                         metadata:     call_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.get_workflow_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches a single WorkflowInvocation.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workflow invocation resource's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5772

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::V1::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
  call_metadata = @config.rpcs.get_workflow_invocation.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_workflow_invocation.timeout,
                         metadata:     call_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.get_workflow_invocation request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Fetches a single Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2793

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.get_workspace.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_workspace.timeout,
                         metadata:     call_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.get_workspace request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Installs dependency NPM packages (inside a Workspace).

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3033

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::V1::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
  call_metadata = @config.rpcs.install_npm_packages.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.install_npm_packages.timeout,
                         metadata:     call_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.install_npm_packages request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists CompilationResults in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CompilationResult>

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

    Parameters:

    • parent (::String) (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, with the exception of page_size, must match the call that provided the page token.

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

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

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

      Optional. Filter for the returned list.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4910

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::V1::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
  call_metadata = @config.rpcs.list_compilation_results.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_compilation_results.timeout,
                         metadata:     call_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.list_compilation_results request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_compilation_results, "compilation_results", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists ReleaseConfigs in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::ListReleaseConfigsRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::ReleaseConfig>

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

    Parameters:

    • parent (::String) (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, with the exception of page_size, must match the call that provided the page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4482

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::V1::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
  call_metadata = @config.rpcs.list_release_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_release_configs.timeout,
                         metadata:     call_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.list_release_configs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_release_configs, "release_configs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists Repositories in a given project and location.

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Repository>

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

    Parameters:

    • parent (::String) (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, with the exception of page_size, 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1658

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.list_repositories.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_repositories.timeout,
                         metadata:     call_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.list_repositories request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_repositories, "repositories", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists WorkflowConfigs in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::ListWorkflowConfigsRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowConfig>

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

    Parameters:

    • parent (::String) (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, with the exception of page_size, must match the call that provided the page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5264

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::V1::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
  call_metadata = @config.rpcs.list_workflow_configs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_workflow_configs.timeout,
                         metadata:     call_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.list_workflow_configs request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_workflow_configs, "workflow_configs", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists WorkflowInvocations in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowInvocation>

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

    Parameters:

    • parent (::String) (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, with the exception of page_size, 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5692

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::V1::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
  call_metadata = @config.rpcs.list_workflow_invocations.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_workflow_invocations.timeout,
                         metadata:     call_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.list_workflow_invocations request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_workflow_invocations, "workflow_invocations", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Lists Workspaces in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::Workspace>

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

    Parameters:

    • parent (::String) (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, with the exception of page_size, 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2713
2714
2715
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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2713

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.list_workspaces.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_workspaces.timeout,
                         metadata:     call_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.list_workspaces request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :list_workspaces, "workspaces", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


221
222
223
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 221

def logger
  @dataform_stub.logger
end

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

Creates a directory inside a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::MakeDirectoryResponse

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

    Parameters:

    • workspace (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3891

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.make_directory.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.make_directory.timeout,
                         metadata:     call_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.make_directory request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#move_directory(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::MoveDirectoryResponse #move_directory(workspace: nil, path: nil, new_path: nil) ⇒ ::Google::Cloud::Dataform::V1::MoveDirectoryResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::MoveDirectoryResponse

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

    Parameters:

    • workspace (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4057

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.move_directory.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.move_directory.timeout,
                         metadata:     call_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.move_directory request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#move_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::MoveFileResponse #move_file(workspace: nil, path: nil, new_path: nil) ⇒ ::Google::Cloud::Dataform::V1::MoveFileResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #move_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::MoveFileResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::MoveFileRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::MoveFileResponse

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

    Parameters:

    • workspace (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4306

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.move_file.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.move_file.timeout,
                         metadata:     call_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.move_file request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#move_folder(request, options = nil) ⇒ ::Gapic::Operation #move_folder(name: nil, destination_containing_folder: nil) ⇒ ::Gapic::Operation

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #move_folder(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::MoveFolderRequest, ::Hash) —

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

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

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

  • #move_folder(name: nil, destination_containing_folder: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. The full resource name of the Folder to move.

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

      Optional. The name of the Folder, TeamFolder, or root location to move the Folder to. Can be in the format of: "" to move into the root User folder, projects/*/locations/*/folders/*, projects/*/locations/*/teamFolders/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



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
1587
1588
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1553

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::MoveFolderRequest

  # 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
  call_metadata = @config.rpcs.move_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.move_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.move_folder.retry_policy

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

  @dataform_stub.move_folder request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#move_repository(request, options = nil) ⇒ ::Gapic::Operation #move_repository(name: nil, destination_containing_folder: nil) ⇒ ::Gapic::Operation

Moves a Repository to a new location.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #move_repository(request, options = nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::MoveRepositoryRequest, ::Hash) —

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

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

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

  • #move_repository(name: nil, destination_containing_folder: nil) ⇒ ::Gapic::Operation

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

    Parameters:

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

      Required. The full resource name of the repository to move.

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

      Optional. The name of the Folder, TeamFolder, or root location to move the repository to. Can be in the format of: "" to move into the root User folder, projects/*/locations/*/folders/*, projects/*/locations/*/teamFolders/*

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



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
2118
2119
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2084

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::MoveRepositoryRequest

  # 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
  call_metadata = @config.rpcs.move_repository.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.move_repository.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.move_repository.retry_policy

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

  @dataform_stub.move_repository request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#pull_git_commits(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::PullGitCommitsResponse #pull_git_commits(name: nil, remote_branch: nil, author: nil) ⇒ ::Google::Cloud::Dataform::V1::PullGitCommitsResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #pull_git_commits(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::PullGitCommitsResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::PullGitCommitsRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Cloud::Dataform::V1::PullGitCommitsResponse

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

    Parameters:

    • name (::String) (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::V1::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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3117

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::V1::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
  call_metadata = @config.rpcs.pull_git_commits.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.pull_git_commits.timeout,
                         metadata:     call_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.pull_git_commits request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#push_git_commits(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::PushGitCommitsResponse #push_git_commits(name: nil, remote_branch: nil) ⇒ ::Google::Cloud::Dataform::V1::PushGitCommitsResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #push_git_commits(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::PushGitCommitsResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::PushGitCommitsRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Cloud::Dataform::V1::PushGitCommitsResponse

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

    Parameters:

    • name (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3199

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::V1::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
  call_metadata = @config.rpcs.push_git_commits.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.push_git_commits.timeout,
                         metadata:     call_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.push_git_commits request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Returns CompilationResultActions in a given CompilationResult.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #query_compilation_result_actions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CompilationResultAction>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::QueryCompilationResultActionsRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::CompilationResultAction>

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

    Parameters:

    • name (::String) (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, with the exception of page_size, 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5168

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::V1::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
  call_metadata = @config.rpcs.query_compilation_result_actions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_compilation_result_actions.timeout,
                         metadata:     call_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.query_compilation_result_actions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :query_compilation_result_actions, "compilation_result_actions", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Returns the contents of a given Workspace directory.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #query_directory_contents(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::QueryDirectoryContentsRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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, view: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>

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

    Parameters:

    • workspace (::String) (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, with the exception of page_size, must match the call that provided the page token.

    • view (::Google::Cloud::Dataform::V1::DirectoryContentsView) (defaults to: nil) —

      Optional. Specifies the metadata to return for each directory entry. If unspecified, the default is DIRECTORY_CONTENTS_VIEW_BASIC. Currently the DIRECTORY_CONTENTS_VIEW_METADATA view is not supported by CMEK-protected workspaces.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3709

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::V1::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
  call_metadata = @config.rpcs.query_directory_contents.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_directory_contents.timeout,
                         metadata:     call_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.query_directory_contents request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :query_directory_contents, "directory_entries", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Returns the contents of a given Folder.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #query_folder_contents(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::QueryFolderContentsRequest, ::Hash) —

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

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

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

  • #query_folder_contents(folder: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryFolderContentsResponse::FolderContentsEntry>

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

    Parameters:

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

      Required. Name of the folder whose contents to list. Format: projects//locations//folders/*

    • 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 QueryFolderContents call. Provide this to retrieve the subsequent page.

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

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

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

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

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

      Example:

      • filter="display_name="MyFolder""

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1351

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::QueryFolderContentsRequest

  # 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
  call_metadata = @config.rpcs.query_folder_contents.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_folder_contents.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.query_folder_contents.retry_policy

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

  @dataform_stub.query_folder_contents request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :query_folder_contents, "entries", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #query_repository_directory_contents(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::QueryRepositoryDirectoryContentsRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::DirectoryEntry>

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

    Parameters:

    • name (::String) (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, with the exception of page_size, must match the call that provided the page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2359

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::V1::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
  call_metadata = @config.rpcs.query_repository_directory_contents.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_repository_directory_contents.timeout,
                         metadata:     call_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.query_repository_directory_contents request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :query_repository_directory_contents, "directory_entries", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Returns the contents of a given TeamFolder.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #query_team_folder_contents(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::QueryTeamFolderContentsRequest, ::Hash) —

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

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

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

  • #query_team_folder_contents(team_folder: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryTeamFolderContentsResponse::TeamFolderContentsEntry>

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

    Parameters:

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

      Required. Name of the team_folder whose contents to list. Format: projects/*/locations/*/teamFolders/*.

    • 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 QueryTeamFolderContents call. Provide this to retrieve the subsequent page.

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

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

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

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

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

      Example:

      • filter="display_name="MyFolder""

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
748
749
750
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 715

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::QueryTeamFolderContentsRequest

  # 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
  call_metadata = @config.rpcs.query_team_folder_contents.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_team_folder_contents.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.query_team_folder_contents.retry_policy

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

  @dataform_stub.query_team_folder_contents request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :query_team_folder_contents, "entries", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #query_user_root_contents(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::QueryUserRootContentsRequest, ::Hash) —

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

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

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

  • #query_user_root_contents(location: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::QueryUserRootContentsResponse::RootContentsEntry>

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

    Parameters:

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

      Required. Location of the user root folder whose contents to list. Format: projects//locations/

    • 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 QueryUserRootContents call. Provide this to retrieve the subsequent page.

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

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

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

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

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

      Example:

      • filter="display_name="MyFolder""

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1462

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::QueryUserRootContentsRequest

  # 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
  call_metadata = @config.rpcs.query_user_root_contents.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_user_root_contents.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.query_user_root_contents.retry_policy

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

  @dataform_stub.query_user_root_contents request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :query_user_root_contents, "entries", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #query_workflow_invocation_actions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowInvocationAction>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::QueryWorkflowInvocationActionsRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::WorkflowInvocationAction>

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

    Parameters:

    • name (::String) (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, with the exception of page_size, must match the call that provided the page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 6103

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::V1::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
  call_metadata = @config.rpcs.query_workflow_invocation_actions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.query_workflow_invocation_actions.timeout,
                         metadata:     call_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.query_workflow_invocation_actions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :query_workflow_invocation_actions, "workflow_invocation_actions", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#read_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ReadFileResponse #read_file(workspace: nil, path: nil, revision: nil) ⇒ ::Google::Cloud::Dataform::V1::ReadFileResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #read_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ReadFileResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::ReadFileRequest, ::Hash) —

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

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

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

  • #read_file(workspace: nil, path: nil, revision: nil) ⇒ ::Google::Cloud::Dataform::V1::ReadFileResponse

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

    Parameters:

    • workspace (::String) (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.

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

      Optional. The Git revision of the file to return. If left empty, the current contents of path will be returned.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4141

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.read_file.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.read_file.timeout,
                         metadata:     call_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.read_file request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#read_repository_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ReadRepositoryFileResponse #read_repository_file(name: nil, commit_sha: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1::ReadRepositoryFileResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #read_repository_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ReadRepositoryFileResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::ReadRepositoryFileRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::V1::ReadRepositoryFileResponse

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

    Parameters:

    • name (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 2258

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::V1::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
  call_metadata = @config.rpcs.read_repository_file.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.read_repository_file.timeout,
                         metadata:     call_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.read_repository_file request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#remove_directory(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::RemoveDirectoryResponse #remove_directory(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1::RemoveDirectoryResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #remove_directory(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::RemoveDirectoryResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::RemoveDirectoryRequest, ::Hash) —

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

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

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

  • #remove_directory(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1::RemoveDirectoryResponse

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

    Parameters:

    • workspace (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3972

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.remove_directory.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.remove_directory.timeout,
                         metadata:     call_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.remove_directory request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#remove_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::RemoveFileResponse #remove_file(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1::RemoveFileResponse

Deletes a file (inside a Workspace).

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #remove_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::RemoveFileResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::RemoveFileRequest, ::Hash) —

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

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

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

  • #remove_file(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1::RemoveFileResponse

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

    Parameters:

    • workspace (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4222

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.remove_file.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.remove_file.timeout,
                         metadata:     call_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.remove_file request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#reset_workspace_changes(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ResetWorkspaceChangesResponse #reset_workspace_changes(name: nil, paths: nil, clean: nil) ⇒ ::Google::Cloud::Dataform::V1::ResetWorkspaceChangesResponse

Performs a Git reset for uncommitted files in a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #reset_workspace_changes(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ResetWorkspaceChangesResponse

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::ResetWorkspaceChangesRequest, ::Hash) —

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

    • options (::Gapic::CallOptions, ::Hash) (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::Cloud::Dataform::V1::ResetWorkspaceChangesResponse

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

    Parameters:

    • name (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3527
3528
3529
3530
3531
3532
3533
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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3527

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::V1::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
  call_metadata = @config.rpcs.reset_workspace_changes.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.reset_workspace_changes.timeout,
                         metadata:     call_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.reset_workspace_changes request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Finds the contents of a given Workspace directory by filter.

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #search_files(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchResult>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::SearchFilesRequest, ::Hash) —

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

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

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

  • #search_files(workspace: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchResult>

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

    Parameters:

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

      Required. The workspace's name.

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

      Optional. Maximum number of search results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

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

      Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3808
3809
3810
3811
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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 3808

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::SearchFilesRequest

  # 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
  call_metadata = @config.rpcs.search_files.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_files.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_files.retry_policy

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

  @dataform_stub.search_files request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :search_files, "search_results", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

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

Examples:

Basic example

require "google/cloud/dataform/v1"

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

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

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

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

Overloads:

  • #search_team_folders(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>

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

    Parameters:

    • request (::Google::Cloud::Dataform::V1::SearchTeamFoldersRequest, ::Hash) —

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

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

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

  • #search_team_folders(location: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1::SearchTeamFoldersResponse::TeamFolderSearchResult>

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

    Parameters:

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

      Required. Location in which to query TeamFolders. Format: projects/*/locations/*.

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

      Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

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

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

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

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

      Example:

      • filter="display_name="MyFolder""

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 824

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::SearchTeamFoldersRequest

  # 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
  call_metadata = @config.rpcs.search_team_folders.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_team_folders.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_team_folders.retry_policy

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

  @dataform_stub.search_team_folders request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @dataform_stub, :search_team_folders, "results", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#set_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy #set_iam_policy(resource: nil, policy: nil, update_mask: nil) ⇒ ::Google::Iam::V1::Policy

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

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::SetIamPolicyRequest.new

# Call the set_iam_policy method.
result = client.set_iam_policy request

# The returned object is of type Google::Iam::V1::Policy.
p result

Overloads:

  • #set_iam_policy(request, options = nil) ⇒ ::Google::Iam::V1::Policy

    Pass arguments to set_iam_policy via a request object, either of type Iam::V1::SetIamPolicyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Iam::V1::SetIamPolicyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #set_iam_policy(resource: nil, policy: nil, update_mask: nil) ⇒ ::Google::Iam::V1::Policy

    Pass arguments to set_iam_policy via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • resource (::String) (defaults to: nil) —

      REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

    • policy (::Google::Iam::V1::Policy, ::Hash) (defaults to: nil) —

      REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:

      paths: "bindings, etag"

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Google::Iam::V1::Policy)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Google::Iam::V1::Policy)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 6445

def set_iam_policy request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::SetIamPolicyRequest

  # 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
  call_metadata = @config.rpcs.set_iam_policy.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.set_iam_policy.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.set_iam_policy.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.set_iam_policy request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#test_iam_permissions(request, options = nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse #test_iam_permissions(resource: nil, permissions: nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Iam::V1::TestIamPermissionsRequest.new

# Call the test_iam_permissions method.
result = client.test_iam_permissions request

# The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
p result

Overloads:

  • #test_iam_permissions(request, options = nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

    Pass arguments to test_iam_permissions via a request object, either of type Iam::V1::TestIamPermissionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Iam::V1::TestIamPermissionsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #test_iam_permissions(resource: nil, permissions: nil) ⇒ ::Google::Iam::V1::TestIamPermissionsResponse

    Pass arguments to test_iam_permissions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • resource (::String) (defaults to: nil) —

      REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

    • permissions (::Array<::String>) (defaults to: nil) —

      The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Google::Iam::V1::TestIamPermissionsResponse)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Google::Iam::V1::TestIamPermissionsResponse)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 6535

def test_iam_permissions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::V1::TestIamPermissionsRequest

  # 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
  call_metadata = @config.rpcs.test_iam_permissions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.test_iam_permissions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.test_iam_permissions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.test_iam_permissions request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


109
110
111
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 109

def universe_domain
  @dataform_stub.universe_domain
end

#update_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Config #update_config(config: nil, update_mask: nil) ⇒ ::Google::Cloud::Dataform::V1::Config

Update default config for a given project and location.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateConfigRequest.new

# Call the update_config method.
result = client.update_config request

# The returned object is of type Google::Cloud::Dataform::V1::Config.
p result

Overloads:

  • #update_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Config

    Pass arguments to update_config via a request object, either of type UpdateConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::UpdateConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_config(config: nil, update_mask: nil) ⇒ ::Google::Cloud::Dataform::V1::Config

    Pass arguments to update_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 6268

def update_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::UpdateConfigRequest

  # 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
  call_metadata = @config.rpcs.update_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.update_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Folder #update_folder(update_mask: nil, folder: nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

Updates a single Folder.

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateFolderRequest.new

# Call the update_folder method.
result = client.update_folder request

# The returned object is of type Google::Cloud::Dataform::V1::Folder.
p result

Overloads:

  • #update_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

    Pass arguments to update_folder via a request object, either of type UpdateFolderRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::UpdateFolderRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_folder(update_mask: nil, folder: nil) ⇒ ::Google::Cloud::Dataform::V1::Folder

    Pass arguments to update_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. Specifies the fields to be updated in the Folder. If left unset, all fields that can be updated, will be updated. A few fields cannot be updated and will be ignored if specified in the update_mask (e.g. parent_name, team_folder_name).

    • folder (::Google::Cloud::Dataform::V1::Folder, ::Hash) (defaults to: nil) —

      Required. The updated Folder.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1068

def update_folder request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::UpdateFolderRequest

  # 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
  call_metadata = @config.rpcs.update_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_folder.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.update_folder request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ReleaseConfig #update_release_config(update_mask: nil, release_config: nil) ⇒ ::Google::Cloud::Dataform::V1::ReleaseConfig

Updates a single ReleaseConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateReleaseConfigRequest.new

# Call the update_release_config method.
result = client.update_release_config request

# The returned object is of type Google::Cloud::Dataform::V1::ReleaseConfig.
p result

Overloads:

  • #update_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::ReleaseConfig

    Pass arguments to update_release_config via a request object, either of type UpdateReleaseConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::UpdateReleaseConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_release_config(update_mask: nil, release_config: nil) ⇒ ::Google::Cloud::Dataform::V1::ReleaseConfig

    Pass arguments to update_release_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4732

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::V1::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
  call_metadata = @config.rpcs.update_release_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_release_config.timeout,
                         metadata:     call_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.update_release_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Repository #update_repository(update_mask: nil, repository: nil) ⇒ ::Google::Cloud::Dataform::V1::Repository

Updates a single Repository.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateRepositoryRequest.new

# Call the update_repository method.
result = client.update_repository request

# The returned object is of type Google::Cloud::Dataform::V1::Repository.
p result

Overloads:

  • #update_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::Repository

    Pass arguments to update_repository via a request object, either of type UpdateRepositoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::UpdateRepositoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (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::V1::Repository

    Pass arguments to update_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



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
1937
1938
1939
1940
1941
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 1908

def update_repository request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.update_repository.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_repository.timeout,
                         metadata:     call_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.update_repository request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_team_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder #update_team_folder(update_mask: nil, team_folder: nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

Updates a single TeamFolder.

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateTeamFolderRequest.new

# Call the update_team_folder method.
result = client.update_team_folder request

# The returned object is of type Google::Cloud::Dataform::V1::TeamFolder.
p result

Overloads:

  • #update_team_folder(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

    Pass arguments to update_team_folder via a request object, either of type UpdateTeamFolderRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::UpdateTeamFolderRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_team_folder(update_mask: nil, team_folder: nil) ⇒ ::Google::Cloud::Dataform::V1::TeamFolder

    Pass arguments to update_team_folder via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



432
433
434
435
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
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 432

def update_team_folder request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::UpdateTeamFolderRequest

  # 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
  call_metadata = @config.rpcs.update_team_folder.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_team_folder.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_team_folder.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @dataform_stub.update_team_folder request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::WorkflowConfig #update_workflow_config(update_mask: nil, workflow_config: nil) ⇒ ::Google::Cloud::Dataform::V1::WorkflowConfig

Updates a single WorkflowConfig.

Note: This method does not fully implement AIP/134. The wildcard entry (*) is treated as a bad request, and when the field_mask is omitted, the request is treated as a full update on all modifiable fields.

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::UpdateWorkflowConfigRequest.new

# Call the update_workflow_config method.
result = client.update_workflow_config request

# The returned object is of type Google::Cloud::Dataform::V1::WorkflowConfig.
p result

Overloads:

  • #update_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::WorkflowConfig

    Pass arguments to update_workflow_config via a request object, either of type UpdateWorkflowConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::UpdateWorkflowConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_workflow_config(update_mask: nil, workflow_config: nil) ⇒ ::Google::Cloud::Dataform::V1::WorkflowConfig

    Pass arguments to update_workflow_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 5514

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::V1::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
  call_metadata = @config.rpcs.update_workflow_config.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_workflow_config.timeout,
                         metadata:     call_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.update_workflow_config request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#write_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::WriteFileResponse #write_file(workspace: nil, path: nil, contents: nil) ⇒ ::Google::Cloud::Dataform::V1::WriteFileResponse

Writes to a file (inside a Workspace).

Examples:

Basic example

require "google/cloud/dataform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1::WriteFileRequest.new

# Call the write_file method.
result = client.write_file request

# The returned object is of type Google::Cloud::Dataform::V1::WriteFileResponse.
p result

Overloads:

  • #write_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1::WriteFileResponse

    Pass arguments to write_file via a request object, either of type WriteFileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1::WriteFileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (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::V1::WriteFileResponse

    Pass arguments to write_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
 
# File 'lib/google/cloud/dataform/v1/dataform/rest/client.rb', line 4388

def write_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1::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
  call_metadata = @config.rpcs.write_file.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.write_file.timeout,
                         metadata:     call_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.write_file request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end