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:



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

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
  )

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


185
186
187
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 185

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) 


178
179
180
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 178

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:



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

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.



4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4358

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 and x-goog-user-project 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-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?
    return result
  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.



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 666

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 and x-goog-user-project 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-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?
    return result
  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.



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1930

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 and x-goog-user-project 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-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?
    return result
  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.



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1024

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 and x-goog-user-project 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-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?
    return result
  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:



96
97
98
99
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 96

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.



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

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 and x-goog-user-project 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-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?
    return result
  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.



3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3021

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 and x-goog-user-project 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-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?
    return result
  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.



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 415

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 and x-goog-user-project 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-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?
    return result
  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.



3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3785

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 and x-goog-user-project 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-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?
    return result
  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.



4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4202

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 and x-goog-user-project 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-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?
    return result
  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.



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1363

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 and x-goog-user-project 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-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?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a single ReleaseConfig.

Examples:

Basic example

require "google/cloud/dataform/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.



3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3180

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 and x-goog-user-project 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-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?
    return result
  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.



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 578

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 and x-goog-user-project 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-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?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Deletes a single WorkflowConfig.

Examples:

Basic example

require "google/cloud/dataform/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.



3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3944

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 and x-goog-user-project 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-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?
    return result
  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.



4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4280

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 and x-goog-user-project 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-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?
    return result
  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.



1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1441

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 and x-goog-user-project 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-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?
    return result
  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.



2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2094

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 and x-goog-user-project 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-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?
    return result
  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.



1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1763

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 and x-goog-user-project 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-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?
    return result
  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.



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1845

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 and x-goog-user-project 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-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?
    return result
  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.



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

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 and x-goog-user-project 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-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?
    return result
  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.



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 945

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 and x-goog-user-project 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-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?
    return 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.



3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3351

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 and x-goog-user-project 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-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?
    return result
  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.



2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2937

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 and x-goog-user-project 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-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?
    return result
  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.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 331

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 and x-goog-user-project 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-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?
    return result
  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.



3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3701

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 and x-goog-user-project 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-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?
    return result
  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.



4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4121

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 and x-goog-user-project 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-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?
    return result
  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.



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1279

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 and x-goog-user-project 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-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?
    return result
  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.



1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1519

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 and x-goog-user-project 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-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?
    return result
  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.



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

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 and x-goog-user-project 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-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?
    return result
  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.



2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2859

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 and x-goog-user-project 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-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?
    return result
  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.



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 253

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 and x-goog-user-project 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-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?
    return result
  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.



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

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 and x-goog-user-project 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-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?
    return result
  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.



4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4043

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 and x-goog-user-project 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-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?
    return result
  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.



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1201

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 and x-goog-user-project 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-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?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Creates a directory inside a Workspace.

Examples:

Basic example

require "google/cloud/dataform/v1beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Dataform::V1beta1::Dataform::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.



2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2272

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 and x-goog-user-project 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-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?
    return result
  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.



2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2438

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 and x-goog-user-project 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-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?
    return result
  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.



2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2684

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 and x-goog-user-project 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-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?
    return result
  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.



1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1603

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 and x-goog-user-project 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-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?
    return result
  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.



1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 1685

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 and x-goog-user-project 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-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?
    return result
  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.



3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3529

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 and x-goog-user-project 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-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?
    return 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.



2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2190

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 and x-goog-user-project 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-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?
    return 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.



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 851

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 and x-goog-user-project 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-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?
    return 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.



4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 4452

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 and x-goog-user-project 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-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?
    return 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.



2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2519

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 and x-goog-user-project 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-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?
    return result
  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.



750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 750

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 and x-goog-user-project 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-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?
    return result
  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.



2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2353

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 and x-goog-user-project 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-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?
    return result
  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.



2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2600

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 and x-goog-user-project 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-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?
    return result
  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.



2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2013

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 and x-goog-user-project 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-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?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 106

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.



3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3102

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 and x-goog-user-project 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-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?
    return result
  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.



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 496

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 and x-goog-user-project 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-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?
    return result
  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.



3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 3866

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 and x-goog-user-project 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-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?
    return result
  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.



2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
 
# File 'lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb', line 2766

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 and x-goog-user-project 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-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?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end