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

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/dataform/v1beta1/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, #location_path, #release_config_path, #repository_path, #secret_version_path, #workflow_config_path, #workflow_invocation_path, #workspace_path

Constructor Details

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

Create a new Dataform REST client object.

Examples:


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

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

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
 
# File 'lib/google/cloud/dataform/v1beta1/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

  @dataform_stub = ::Google::Cloud::Dataform::V1beta1::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.bindings_override = @config.bindings_override
    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) 


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

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) 


194
195
196
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 194

def location_client
  @location_client
end

Class Method Details

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

Configure the Dataform Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Dataform clients
::Google::Cloud::Dataform::V1beta1::Dataform::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/v1beta1/dataform/rest/client.rb', line 67

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

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Requests cancellation of a running WorkflowInvocation.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workflow invocation resource's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::Protobuf::Empty #commit_repository_changes(name: nil, commit_metadata: nil, required_head_commit_sha: nil, file_operations: nil) ⇒ ::Google::Protobuf::Empty

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

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The repository's name.

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

      Required. The changes to commit to the repository.

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

      Optional. The commit SHA which must be the repository's current HEAD before applying this commit; otherwise this request will fail. If unset, no validation on the current HEAD commit SHA is performed.

    • file_operations (::Hash{::String => ::Google::Cloud::Dataform::V1beta1::CommitRepositoryChangesRequest::FileOperation, ::Hash}) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 691

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::Protobuf::Empty #commit_workspace_changes(name: nil, author: nil, commit_message: nil, paths: nil) ⇒ ::Google::Protobuf::Empty

Applies a Git commit for uncommitted files in a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

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

      Required. The commit's author.

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

      Optional. The commit's message.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1957

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::ComputeRepositoryAccessTokenStatusResponse #compute_repository_access_token_status(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ComputeRepositoryAccessTokenStatusResponse

Computes a Repository's Git access token status.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1051

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

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

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

  # Customize the options with defaults
  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::V1beta1::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/v1beta1/dataform/rest/client.rb', line 99

def configure
  yield @config if block_given?
  @config
end

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

Creates a new CompilationResult in a given project and location.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

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

    • compilation_result (::Google::Cloud::Dataform::V1beta1::CompilationResult, ::Hash) (defaults to: nil) —

      Required. The compilation result to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3460

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

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

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

  # Customize the options with defaults
  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::V1beta1::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_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig #create_release_config(parent: nil, release_config: nil, release_config_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

Creates a new ReleaseConfig in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

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

    • release_config (::Google::Cloud::Dataform::V1beta1::ReleaseConfig, ::Hash) (defaults to: nil) —

      Required. The release config to create.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3049

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::Repository #create_repository(parent: nil, repository: nil, repository_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

Creates a new Repository in a given project and location.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

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

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

      Required. The repository to create.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig #create_workflow_config(parent: nil, workflow_config: nil, workflow_config_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

Creates a new WorkflowConfig in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

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

    • workflow_config (::Google::Cloud::Dataform::V1beta1::WorkflowConfig, ::Hash) (defaults to: nil) —

      Required. The workflow config to create.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3814

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::WorkflowInvocation #create_workflow_invocation(parent: nil, workflow_invocation: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

Creates a new WorkflowInvocation in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

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

    • workflow_invocation (::Google::Cloud::Dataform::V1beta1::WorkflowInvocation, ::Hash) (defaults to: nil) —

      Required. The workflow invocation resource to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
4256
4257
4258
4259
4260
4261
4262
4263
4264
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4231

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::Workspace #create_workspace(parent: nil, workspace: nil, workspace_id: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace

Creates a new Workspace in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

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

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

      Required. The workspace to create.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1390

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

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

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

  # Customize the options with defaults
  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::V1beta1::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_release_config(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_release_config(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a single ReleaseConfig.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The release config's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
3233
3234
3235
3236
3237
3238
3239
3240
3241
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3208

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

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

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

  # Customize the options with defaults
  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::V1beta1::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/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The repository's name.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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_workflow_config(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_workflow_config(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a single WorkflowConfig.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workflow config's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workflow invocation resource's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
4340
4341
4342
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4309

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

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

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

  # Customize the options with defaults
  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::V1beta1::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/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace resource's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::FetchFileDiffResponse #fetch_file_diff(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchFileDiffResponse

Fetches Git diff for an uncommitted file in a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2121

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::FetchFileGitStatusesResponse #fetch_file_git_statuses(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchFileGitStatusesResponse

Fetches Git statuses for the files in a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1790

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::FetchGitAheadBehindResponse #fetch_git_ahead_behind(name: nil, remote_branch: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchGitAheadBehindResponse

Fetches Git ahead/behind against a remote branch.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1872

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::FetchRemoteBranchesResponse #fetch_remote_branches(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::FetchRemoteBranchesResponse

Fetches a Repository's remote branches.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1129

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::CommitLogEntry> #fetch_repository_history(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CommitLogEntry>

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

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The repository's name.

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

      Optional. Maximum number of commits to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 971

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::CompilationResult #get_compilation_result(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::CompilationResult

Fetches a single CompilationResult.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The compilation result's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3379

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

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

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

  # Customize the options with defaults
  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::V1beta1::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_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig #get_release_config(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

Fetches a single ReleaseConfig.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The release config's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2965

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::Repository #get_repository(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

Fetches a single Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The repository's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
385
386
387
388
389
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 356

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

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

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

  # Customize the options with defaults
  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::V1beta1::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_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig #get_workflow_config(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

Fetches a single WorkflowConfig.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workflow config's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3730

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::WorkflowInvocation #get_workflow_invocation(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowInvocation

Fetches a single WorkflowInvocation.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workflow invocation resource's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
4175
4176
4177
4178
4179
4180
4181
4182
4183
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4150

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::Workspace #get_workspace(name: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Workspace

Fetches a single Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1306

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::InstallNpmPackagesResponse #install_npm_packages(workspace: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesResponse

Installs dependency NPM packages (inside a Workspace).

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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) ⇒ ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse #list_compilation_results(parent: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse

Lists CompilationResults in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #list_compilation_results(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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) ⇒ ::Google::Cloud::Dataform::V1beta1::ListCompilationResultsResponse

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

    Parameters:

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

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

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

      Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3301

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

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

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

  # Customize the options with defaults
  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::V1beta1::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|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_release_configs(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListReleaseConfigsResponse #list_release_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListReleaseConfigsResponse

Lists ReleaseConfigs in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #list_release_configs(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListReleaseConfigsResponse

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

    Parameters:

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

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

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

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

  • #list_release_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListReleaseConfigsResponse

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

    Parameters:

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

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

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

      Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2887

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

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

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

  # Customize the options with defaults
  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::V1beta1::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|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_repositories(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse #list_repositories(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse

Lists Repositories in a given project and location.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #list_repositories(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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) ⇒ ::Google::Cloud::Dataform::V1beta1::ListRepositoriesResponse

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

    Parameters:

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

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

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

      Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

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

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

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

      Optional. Filter for the returned list.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
304
305
306
307
308
309
310
311
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 278

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

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

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

  # Customize the options with defaults
  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::V1beta1::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|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workflow_configs(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkflowConfigsResponse #list_workflow_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkflowConfigsResponse

Lists WorkflowConfigs in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #list_workflow_configs(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkflowConfigsResponse

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

    Parameters:

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

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

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

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

  • #list_workflow_configs(parent: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkflowConfigsResponse

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

    Parameters:

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

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

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

      Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3652

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

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

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

  # Customize the options with defaults
  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::V1beta1::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|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workflow_invocations(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse #list_workflow_invocations(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse

Lists WorkflowInvocations in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #list_workflow_invocations(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkflowInvocationsResponse

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

    Parameters:

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

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

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

      Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

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

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

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

      Optional. Filter for the returned list.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4072

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

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

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

  # Customize the options with defaults
  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::V1beta1::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|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_workspaces(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse #list_workspaces(parent: nil, page_size: nil, page_token: nil, order_by: nil, filter: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse

Lists Workspaces in a given Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #list_workspaces(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse

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

    Parameters:

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

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

    • options (::Gapic::CallOptions, ::Hash) (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) ⇒ ::Google::Cloud::Dataform::V1beta1::ListWorkspacesResponse

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

    Parameters:

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

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

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

      Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

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

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

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

      Optional. Filter for the returned list.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1228

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

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

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

  # Customize the options with defaults
  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::V1beta1::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|
    yield result, operation if block_given?
  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) 


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

def logger
  @dataform_stub.logger
end

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

Creates a directory inside a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2300

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::MoveDirectoryResponse #move_directory(workspace: nil, path: nil, new_path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveDirectoryResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

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

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

    Parameters:

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

      Required. The workspace's name.

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

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

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

      Required. The new path for the directory including directory name, rooted at workspace root.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
2491
2492
2493
2494
2495
2496
2497
2498
2499
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2466

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::MoveFileResponse #move_file(workspace: nil, path: nil, new_path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveFileResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #move_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveFileResponse

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

    Parameters:

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

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

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

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

  • #move_file(workspace: nil, path: nil, new_path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::MoveFileResponse

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

    Parameters:

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

      Required. The workspace's name.

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

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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

#pull_git_commits(request, options = nil) ⇒ ::Google::Protobuf::Empty #pull_git_commits(name: nil, remote_branch: nil, author: nil) ⇒ ::Google::Protobuf::Empty

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

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

  • #pull_git_commits(name: nil, remote_branch: nil, author: nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

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

      Required. The workspace's name.

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

      Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.

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

      Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::Protobuf::Empty #push_git_commits(name: nil, remote_branch: nil) ⇒ ::Google::Protobuf::Empty

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

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

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

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

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

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

  • #push_git_commits(name: nil, remote_branch: nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

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

      Required. The workspace's name.

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

      Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1712

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::CompilationResultAction> #query_compilation_result_actions(name: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>

Returns CompilationResultActions in a given CompilationResult.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #query_compilation_result_actions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::CompilationResultAction>

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

    Parameters:

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

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

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

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

    Parameters:

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

      Required. The compilation result's name.

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

      Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

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

      Optional. Optional filter for the returned list. Filtering is only currently supported on the file_path field.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3557

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::DirectoryEntry> #query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

Returns the contents of a given Workspace directory.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #query_directory_contents(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

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

    Parameters:

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

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

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

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

  • #query_directory_contents(workspace: nil, path: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

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

    Parameters:

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

      Required. The workspace's name.

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

      Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.

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

      Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2217

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

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

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

  # Customize the options with defaults
  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::V1beta1::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_repository_directory_contents(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry> #query_repository_directory_contents(name: nil, commit_sha: nil, path: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

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

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #query_repository_directory_contents(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

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

    Parameters:

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

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

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

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

  • #query_repository_directory_contents(name: nil, commit_sha: nil, path: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::DirectoryEntry>

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

    Parameters:

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

      Required. The repository's name.

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

      Optional. The Commit SHA for the commit to query from. If unset, the directory will be queried from HEAD.

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

      Optional. The directory's full path including directory name, relative to root. If left unset, the root is used.

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

      Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 876

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

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

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

  # Customize the options with defaults
  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::V1beta1::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_workflow_invocation_actions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction> #query_workflow_invocation_actions(name: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>

Returns WorkflowInvocationActions in a given WorkflowInvocation.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #query_workflow_invocation_actions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dataform::V1beta1::WorkflowInvocationAction>

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

    Parameters:

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

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

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

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

    Parameters:

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

      Required. The workflow invocation's name.

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

      Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

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

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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

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

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

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

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::ReadFileResponse #read_file(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadFileResponse

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

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

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

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

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

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

Overloads:

  • #read_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadFileResponse

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

    Parameters:

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

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

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

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

  • #read_file(workspace: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadFileResponse

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

    Parameters:

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

      Required. The workspace's name.

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

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

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2547

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ReadFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::ReadRepositoryFileResponse #read_repository_file(name: nil, commit_sha: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse

Returns the contents of a file (inside a Repository). The Repository must not have a value for git_remote_settings.url.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1beta1::ReadRepositoryFileRequest.new

# Call the read_repository_file method.
result = client.read_repository_file request

# The returned object is of type Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse.
p result

Overloads:

  • #read_repository_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse

    Pass arguments to read_repository_file via a request object, either of type ReadRepositoryFileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #read_repository_file(name: nil, commit_sha: nil, path: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileResponse

    Pass arguments to read_repository_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The repository's name.

    • commit_sha (::String) (defaults to: nil) —

      Optional. The commit SHA for the commit to read from. If unset, the file will be read from HEAD.

    • path (::String) (defaults to: nil) —

      Required. Full file path to read including filename, from repository root.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 775

def read_repository_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ReadRepositoryFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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::Protobuf::Empty #remove_directory(workspace: nil, path: nil) ⇒ ::Google::Protobuf::Empty

Deletes a directory (inside a Workspace) and all of its contents.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest.new

# Call the remove_directory method.
result = client.remove_directory request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #remove_directory(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_directory via a request object, either of type RemoveDirectoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #remove_directory(workspace: nil, path: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_directory via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The directory's full path including directory name, relative to the workspace root.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2381

def remove_directory request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::RemoveDirectoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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::Protobuf::Empty #remove_file(workspace: nil, path: nil) ⇒ ::Google::Protobuf::Empty

Deletes a file (inside a Workspace).

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1beta1::RemoveFileRequest.new

# Call the remove_file method.
result = client.remove_file request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #remove_file(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_file via a request object, either of type RemoveFileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::RemoveFileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #remove_file(workspace: nil, path: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to remove_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The file's full path including filename, relative to the workspace root.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2628

def remove_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::RemoveFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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::Protobuf::Empty #reset_workspace_changes(name: nil, paths: nil, clean: nil) ⇒ ::Google::Protobuf::Empty

Performs a Git reset for uncommitted files in a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest.new

# Call the reset_workspace_changes method.
result = client.reset_workspace_changes request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #reset_workspace_changes(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to reset_workspace_changes via a request object, either of type ResetWorkspaceChangesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #reset_workspace_changes(name: nil, paths: nil, clean: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to reset_workspace_changes via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The workspace's name.

    • paths (::Array<::String>) (defaults to: nil) —

      Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset.

    • clean (::Boolean) (defaults to: nil) —

      Optional. If set to true, untracked files will be deleted.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2040

def reset_workspace_changes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::ResetWorkspaceChangesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


109
110
111
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 109

def universe_domain
  @dataform_stub.universe_domain
end

#update_release_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig #update_release_config(update_mask: nil, release_config: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::ReleaseConfig

Updates a single ReleaseConfig.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1beta1::UpdateReleaseConfigRequest.new

# Call the update_release_config method.
result = client.update_release_config request

# The returned object is of type Google::Cloud::Dataform::V1beta1::ReleaseConfig.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3130

def update_release_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::UpdateReleaseConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::Repository #update_repository(update_mask: nil, repository: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

Updates a single Repository.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest.new

# Call the update_repository method.
result = client.update_repository request

# The returned object is of type Google::Cloud::Dataform::V1beta1::Repository.
p result

Overloads:

  • #update_repository(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

    Pass arguments to update_repository via a request object, either of type UpdateRepositoryRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_repository(update_mask: nil, repository: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::Repository

    Pass arguments to update_repository via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 521

def update_repository request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::UpdateRepositoryRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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_workflow_config(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig #update_workflow_config(update_mask: nil, workflow_config: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WorkflowConfig

Updates a single WorkflowConfig.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1beta1::UpdateWorkflowConfigRequest.new

# Call the update_workflow_config method.
result = client.update_workflow_config request

# The returned object is of type Google::Cloud::Dataform::V1beta1::WorkflowConfig.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



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
3925
3926
3927
3928
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3895

def update_workflow_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::UpdateWorkflowConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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::V1beta1::WriteFileResponse #write_file(workspace: nil, path: nil, contents: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WriteFileResponse

Writes to a file (inside a Workspace).

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dataform::V1beta1::WriteFileRequest.new

# Call the write_file method.
result = client.write_file request

# The returned object is of type Google::Cloud::Dataform::V1beta1::WriteFileResponse.
p result

Overloads:

  • #write_file(request, options = nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WriteFileResponse

    Pass arguments to write_file via a request object, either of type WriteFileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Dataform::V1beta1::WriteFileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #write_file(workspace: nil, path: nil, contents: nil) ⇒ ::Google::Cloud::Dataform::V1beta1::WriteFileResponse

    Pass arguments to write_file via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • workspace (::String) (defaults to: nil) —

      Required. The workspace's name.

    • path (::String) (defaults to: nil) —

      Required. The file.

    • contents (::String) (defaults to: nil) —

      Required. The file's contents.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



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
2827
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2794

def write_file request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataform::V1beta1::WriteFileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  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::V1beta1::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