Class: Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb

Overview

Client for the DataTransferService service.

The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. This service contains methods that are end user exposed. It backs up the frontend.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#data_source_path, #location_path, #project_path, #run_path, #transfer_config_path

Constructor Details

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

Create a new DataTransferService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.new

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

Yields:

  • (config) —

    Configure the DataTransferService client.

Yield Parameters:



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 169

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

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

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

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.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

  @data_transfer_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

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

Configure the DataTransferService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all DataTransferService clients
::Google::Cloud::Bigquery::DataTransfer::V1::DataTransferService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 60

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

    default_config.rpcs.get_data_source.timeout = 20.0
    default_config.rpcs.get_data_source.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_data_sources.timeout = 20.0
    default_config.rpcs.list_data_sources.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.create_transfer_config.timeout = 30.0

    default_config.rpcs.update_transfer_config.timeout = 30.0

    default_config.rpcs.delete_transfer_config.timeout = 20.0
    default_config.rpcs.delete_transfer_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_transfer_config.timeout = 20.0
    default_config.rpcs.get_transfer_config.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_transfer_configs.timeout = 20.0
    default_config.rpcs.list_transfer_configs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.schedule_transfer_runs.timeout = 30.0

    default_config.rpcs.get_transfer_run.timeout = 20.0
    default_config.rpcs.get_transfer_run.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_transfer_run.timeout = 20.0
    default_config.rpcs.delete_transfer_run.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_transfer_runs.timeout = 20.0
    default_config.rpcs.list_transfer_runs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.list_transfer_logs.timeout = 20.0
    default_config.rpcs.list_transfer_logs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.check_valid_creds.timeout = 20.0
    default_config.rpcs.check_valid_creds.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#check_valid_creds(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse #check_valid_creds(name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse.
p result

Overloads:

  • #check_valid_creds(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsRequest, ::Hash) —

      A request object representing 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.

  • #check_valid_creds(name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsResponse

    Pass arguments to check_valid_creds via keyword arguments. Note that at least one keyword argument 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 data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::CheckValidCredsRequest

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

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

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

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

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

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

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

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

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

Configure the DataTransferService 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:



148
149
150
151
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 148

def configure
  yield @config if block_given?
  @config
end

#create_transfer_config(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig #create_transfer_config(parent: nil, transfer_config: nil, authorization_code: nil, version_info: nil, service_account_name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Creates a new data transfer configuration.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::CreateTransferConfigRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.
p result

Overloads:

  • #create_transfer_config(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::CreateTransferConfigRequest, ::Hash) —

      A request object representing 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_transfer_config(parent: nil, transfer_config: nil, authorization_code: nil, version_info: nil, service_account_name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

    Pass arguments to create_transfer_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 BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

    • transfer_config (::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig, ::Hash) (defaults to: nil) —

      Required. Data transfer configuration to create.

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

      Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=

      • client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
      • data_source_scopes are the scopes returned by ListDataSources method.
      • redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
    • version_info (::String) (defaults to: nil) —

      Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

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

      Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 476

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::CreateTransferConfigRequest

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

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

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

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

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

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

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

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

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

Deletes a data transfer configuration, including any associated transfer runs and logs.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest.new

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

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

Overloads:

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

    Pass arguments to delete_transfer_config via a request object, either of type Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest, ::Hash) —

      A request object representing 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_transfer_config(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_transfer_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 field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 682

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferConfigRequest

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

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

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

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

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

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

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

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

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

Deletes the specified transfer run.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferRunRequest.new

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

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

Overloads:

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

    Pass arguments to delete_transfer_run via a request object, either of type Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferRunRequest, ::Hash) —

      A request object representing 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_transfer_run(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_transfer_run via keyword arguments. Note that at least one keyword argument 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 field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::DeleteTransferRunRequest

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

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

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

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

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

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

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

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

#get_data_source(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource #get_data_source(name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::GetDataSourceRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::DataSource.
p result

Overloads:

  • #get_data_source(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::GetDataSourceRequest, ::Hash) —

      A request object representing 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_data_source(name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource

    Pass arguments to get_data_source via keyword arguments. Note that at least one keyword argument 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 field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
287
288
289
290
291
292
293
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 254

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::GetDataSourceRequest

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

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

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

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

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

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

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

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

#get_transfer_config(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig #get_transfer_config(name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Returns information about a data transfer config.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::GetTransferConfigRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.
p result

Overloads:

  • #get_transfer_config(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferConfigRequest, ::Hash) —

      A request object representing 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_transfer_config(name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

    Pass arguments to get_transfer_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 field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 769

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferConfigRequest

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

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

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

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

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

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

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

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

#get_transfer_run(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun #get_transfer_run(name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun

Returns information about the particular transfer run.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::GetTransferRunRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::TransferRun.
p result

Overloads:

  • #get_transfer_run(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferRunRequest, ::Hash) —

      A request object representing 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_transfer_run(name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun

    Pass arguments to get_transfer_run via keyword arguments. Note that at least one keyword argument 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 field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 1155

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::GetTransferRunRequest

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

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

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

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

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

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

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

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

#list_data_sources(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::DataSource> #list_data_sources(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::DataSource>

Lists supported data sources and returns their settings, which can be used for UI rendering.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Bigquery::DataTransfer::V1::DataSource.
  p response
end

Overloads:

  • #list_data_sources(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::DataSource>

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesRequest, ::Hash) —

      A request object representing 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_data_sources(parent: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::DataSource>

    Pass arguments to list_data_sources via keyword arguments. Note that at least one keyword argument 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 BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/project_id/locations/location_id

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

      Pagination token, which can be used to request a specific page of ListDataSourcesRequest list results. For multiple-page results, ListDataSourcesResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

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

      Page size. The default page size is the maximum value of 1000 results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 356

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::ListDataSourcesRequest

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

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

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

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

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

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

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

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

#list_transfer_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig> #list_transfer_configs(parent: nil, data_source_ids: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig>

Returns information about all transfer configs owned by a project in the specified location.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.
  p response
end

Overloads:

  • #list_transfer_configs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig>

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsRequest, ::Hash) —

      A request object representing 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_transfer_configs(parent: nil, data_source_ids: nil, page_token: nil, page_size: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig>

    Pass arguments to list_transfer_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 BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

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

      When specified, only configurations of requested data sources are returned.

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

      Pagination token, which can be used to request a specific page of ListTransfersRequest list results. For multiple-page results, ListTransfersResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

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

      Page size. The default page size is the maximum value of 1000 results.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 873

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferConfigsRequest

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

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

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

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

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

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

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

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

#list_transfer_logs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage> #list_transfer_logs(parent: nil, page_token: nil, page_size: nil, message_types: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage>

Returns user facing log messages for the data transfer run.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage.
  p response
end

Overloads:

  • #list_transfer_logs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage>

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsRequest, ::Hash) —

      A request object representing 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_transfer_logs(parent: nil, page_token: nil, page_size: nil, message_types: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage>

    Pass arguments to list_transfer_logs via keyword arguments. Note that at least one keyword argument 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. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

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

      Pagination token, which can be used to request a specific page of ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

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

      Page size. The default page size is the maximum value of 1000 results.

    • message_types (::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferMessage::MessageSeverity>) (defaults to: nil) —

      Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 1453

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferLogsRequest

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

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

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

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

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

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

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

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

#list_transfer_runs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun> #list_transfer_runs(parent: nil, states: nil, page_token: nil, page_size: nil, run_attempt: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>

Returns information about running and completed jobs.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can
# iterate over all elements by calling #each, and the enumerable
# will lazily make API calls to fetch subsequent pages. Other
# methods are also available for managing paging directly.
result.each do |response|
  # Each element is of type ::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun.
  p response
end

Overloads:

  • #list_transfer_runs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest, ::Hash) —

      A request object representing 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_transfer_runs(parent: nil, states: nil, page_token: nil, page_size: nil, run_attempt: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Bigquery::DataTransfer::V1::TransferRun>

    Pass arguments to list_transfer_runs via keyword arguments. Note that at least one keyword argument 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. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

    • states (::Array<::Google::Cloud::Bigquery::DataTransfer::V1::TransferState>) (defaults to: nil) —

      When specified, only transfer runs with requested states are returned.

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

      Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

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

      Page size. The default page size is the maximum value of 1000 results.

    • run_attempt (::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest::RunAttempt) (defaults to: nil) —

      Indicates how run attempts are to be pulled.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 1348

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::ListTransferRunsRequest

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

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

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

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

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

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

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

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

#schedule_transfer_runs(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse #schedule_transfer_runs(parent: nil, start_time: nil, end_time: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse

Deprecated.

This method is deprecated and may be removed in the next major version update.

Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse.
p result

Overloads:

  • #schedule_transfer_runs(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsRequest, ::Hash) —

      A request object representing 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.

  • #schedule_transfer_runs(parent: nil, start_time: nil, end_time: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsResponse

    Pass arguments to schedule_transfer_runs via keyword arguments. Note that at least one keyword argument 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. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

    • start_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".

    • end_time (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 973

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::ScheduleTransferRunsRequest

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

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

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

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

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

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

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

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

#start_manual_transfer_runs(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse #start_manual_transfer_runs(parent: nil, requested_time_range: nil, requested_run_time: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 1068

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::StartManualTransferRunsRequest

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

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

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

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

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

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

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

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

#update_transfer_config(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig #update_transfer_config(transfer_config: nil, authorization_code: nil, update_mask: nil, version_info: nil, service_account_name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

Updates a data transfer configuration. All fields must be set, even if they are not updated.

Examples:

Basic example

require "google/cloud/bigquery/data_transfer/v1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest.new

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

# The returned object is of type Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig.
p result

Overloads:

  • #update_transfer_config(request, options = nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

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

    Parameters:

    • request (::Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest, ::Hash) —

      A request object representing 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_transfer_config(transfer_config: nil, authorization_code: nil, update_mask: nil, version_info: nil, service_account_name: nil) ⇒ ::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig

    Pass arguments to update_transfer_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:

    • transfer_config (::Google::Cloud::Bigquery::DataTransfer::V1::TransferConfig, ::Hash) (defaults to: nil) —

      Required. Data transfer configuration to create.

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

      Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=

      • client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.
      • data_source_scopes are the scopes returned by ListDataSources method.
      • redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Required list of fields to be updated in this request.

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

      Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

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

      Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service/client.rb', line 594

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Bigquery::DataTransfer::V1::UpdateTransferConfigRequest

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

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

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

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

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

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

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

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