Class: Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb

Overview

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.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"bigquerydatatransfer.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ DataTransferServiceClient

Returns a new instance of DataTransferServiceClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
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
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 182

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # 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 "google/gax/grpc"
  require "google/cloud/bigquery/datatransfer/v1/datatransfer_services_pb"

  credentials ||= Google::Cloud::Bigquery::DataTransfer::V1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Bigquery::DataTransfer::V1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-bigquery-data_transfer'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "data_transfer_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.bigquery.datatransfer.v1.DataTransferService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @data_transfer_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Bigquery::Datatransfer::V1::DataTransferService::Stub.method(:new)
  )

  @get_data_source = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:get_data_source),
    defaults["get_data_source"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_data_sources = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:list_data_sources),
    defaults["list_data_sources"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @create_transfer_config = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:create_transfer_config),
    defaults["create_transfer_config"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_transfer_config = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:update_transfer_config),
    defaults["update_transfer_config"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'transfer_config.name' => request.transfer_config.name}
    end
  )
  @delete_transfer_config = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:delete_transfer_config),
    defaults["delete_transfer_config"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_transfer_config = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:get_transfer_config),
    defaults["get_transfer_config"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_transfer_configs = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:list_transfer_configs),
    defaults["list_transfer_configs"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @schedule_transfer_runs = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:schedule_transfer_runs),
    defaults["schedule_transfer_runs"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_transfer_run = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:get_transfer_run),
    defaults["get_transfer_run"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @delete_transfer_run = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:delete_transfer_run),
    defaults["delete_transfer_run"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_transfer_runs = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:list_transfer_runs),
    defaults["list_transfer_runs"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @list_transfer_logs = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:list_transfer_logs),
    defaults["list_transfer_logs"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @check_valid_creds = Google::Gax.create_api_call(
    @data_transfer_service_stub.method(:check_valid_creds),
    defaults["check_valid_creds"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
end

Class Method Details

.project_data_source_path(project, data_source) ⇒ String

Returns a fully-qualified project_data_source resource name string.

Parameters:

  • project (String)
  • data_source (String)

Returns:

  • (String) 


113
114
115
116
117
118
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 113

def self.project_data_source_path project, data_source
  PROJECT_DATA_SOURCE_PATH_TEMPLATE.render(
    :"project" => project,
    :"data_source" => data_source
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


123
124
125
126
127
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 123

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

.project_run_path(project, transfer_config, run) ⇒ String

Returns a fully-qualified project_run resource name string.

Parameters:

  • project (String)
  • transfer_config (String)
  • run (String)

Returns:

  • (String) 


145
146
147
148
149
150
151
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 145

def self.project_run_path project, transfer_config, run
  PROJECT_RUN_PATH_TEMPLATE.render(
    :"project" => project,
    :"transfer_config" => transfer_config,
    :"run" => run
  )
end

.project_transfer_config_path(project, transfer_config) ⇒ String

Returns a fully-qualified project_transfer_config resource name string.

Parameters:

  • project (String)
  • transfer_config (String)

Returns:

  • (String) 


133
134
135
136
137
138
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 133

def self.project_transfer_config_path project, transfer_config
  PROJECT_TRANSFER_CONFIG_PATH_TEMPLATE.render(
    :"project" => project,
    :"transfer_config" => transfer_config
  )
end

Instance Method Details

#check_valid_creds(name, options: nil) {|result, operation| ... } ⇒ 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:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_name = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_data_source_path("[PROJECT]", "[DATA_SOURCE]")
response = data_transfer_service_client.check_valid_creds(formatted_name)

Parameters:

  • name (String) —

    The data source in the form: +projects/{project_id}/dataSources/{data_source_id}+

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



963
964
965
966
967
968
969
970
971
972
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 963

def check_valid_creds \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::CheckValidCredsRequest)
  @check_valid_creds.call(req, options, &block)
end

#create_transfer_config(parent, transfer_config, authorization_code: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig

Creates a new data transfer configuration.

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_path("[PROJECT]")

# TODO: Initialize +transfer_config+:
transfer_config = {}
response = data_transfer_service_client.create_transfer_config(formatted_parent, transfer_config)

Parameters:

  • parent (String) —

    The BigQuery project id where the transfer configuration should be created. Must be in the format /projects/{project_id}/locations/{location_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) —

    Data transfer configuration to create. A hash of the same form as Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig can also be provided.

  • authorization_code (String) —

    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.
  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 498

def create_transfer_config \
    parent,
    transfer_config,
    authorization_code: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    transfer_config: transfer_config,
    authorization_code: authorization_code
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::CreateTransferConfigRequest)
  @create_transfer_config.call(req, options, &block)
end

#delete_transfer_config(name, options: nil) {|result, operation| ... } ⇒ Object

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

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_name = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_transfer_config_path("[PROJECT]", "[TRANSFER_CONFIG]")
data_transfer_service_client.delete_transfer_config(formatted_name)

Parameters:

  • name (String) —

    The field will contain name of the resource requested, for example: +projects/{project_id}/transferConfigs/{config_id}+

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 596

def delete_transfer_config \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::DeleteTransferConfigRequest)
  @delete_transfer_config.call(req, options, &block)
  nil
end

#delete_transfer_run(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes the specified transfer run.

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_name = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_run_path("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]")
data_transfer_service_client.delete_transfer_run(formatted_name)

Parameters:

  • name (String) —

    The field will contain name of the resource requested, for example: +projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}+

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 802

def delete_transfer_run \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::DeleteTransferRunRequest)
  @delete_transfer_run.call(req, options, &block)
  nil
end

#get_data_source(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Bigquery::Datatransfer::V1::DataSource

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

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_name = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_data_source_path("[PROJECT]", "[DATA_SOURCE]")
response = data_transfer_service_client.get_data_source(formatted_name)

Parameters:

  • name (String) —

    The field will contain name of the resource requested, for example: +projects/{project_id}/dataSources/{data_source_id}+

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



385
386
387
388
389
390
391
392
393
394
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 385

def get_data_source \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::GetDataSourceRequest)
  @get_data_source.call(req, options, &block)
end

#get_transfer_config(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig

Returns information about a data transfer config.

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_name = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_transfer_config_path("[PROJECT]", "[TRANSFER_CONFIG]")
response = data_transfer_service_client.get_transfer_config(formatted_name)

Parameters:

  • name (String) —

    The field will contain name of the resource requested, for example: +projects/{project_id}/transferConfigs/{config_id}+

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



628
629
630
631
632
633
634
635
636
637
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 628

def get_transfer_config \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::GetTransferConfigRequest)
  @get_transfer_config.call(req, options, &block)
end

#get_transfer_run(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Bigquery::Datatransfer::V1::TransferRun

Returns information about the particular transfer run.

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_name = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_run_path("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]")
response = data_transfer_service_client.get_transfer_run(formatted_name)

Parameters:

  • name (String) —

    The field will contain name of the resource requested, for example: +projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}+

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



772
773
774
775
776
777
778
779
780
781
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 772

def get_transfer_run \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::GetTransferRunRequest)
  @get_transfer_run.call(req, options, &block)
end

#list_data_sources(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Bigquery::Datatransfer::V1::DataSource>

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

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_path("[PROJECT]")

# Iterate over all results.
data_transfer_service_client.list_data_sources(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
data_transfer_service_client.list_data_sources(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    The BigQuery project id for which data sources should be returned. Must be in the form: +projects/{project_id}+

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Bigquery::Datatransfer::V1::DataSource>) —

    An enumerable of Google::Cloud::Bigquery::Datatransfer::V1::DataSource instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 439

def list_data_sources \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::ListDataSourcesRequest)
  @list_data_sources.call(req, options, &block)
end

#list_transfer_configs(parent, data_source_ids: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig>

Returns information about all data transfers in the project.

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_path("[PROJECT]")

# Iterate over all results.
data_transfer_service_client.list_transfer_configs(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
data_transfer_service_client.list_transfer_configs(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    The BigQuery project id for which data sources should be returned: +projects/{project_id}+.

  • data_source_ids (Array<String>) —

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

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig>) —

    An enumerable of Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 683

def list_transfer_configs \
    parent,
    data_source_ids: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    data_source_ids: data_source_ids,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::ListTransferConfigsRequest)
  @list_transfer_configs.call(req, options, &block)
end

#list_transfer_logs(parent, page_size: nil, message_types: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Bigquery::Datatransfer::V1::TransferMessage>

Returns user facing log messages for the data transfer run.

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_run_path("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]")

# Iterate over all results.
data_transfer_service_client.list_transfer_logs(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
data_transfer_service_client.list_transfer_logs(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Transfer run name in the form: +projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}+.

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • message_types (Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferMessage::MessageSeverity>) —

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

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Bigquery::Datatransfer::V1::TransferMessage>) —

    An enumerable of Google::Cloud::Bigquery::Datatransfer::V1::TransferMessage instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 923

def list_transfer_logs \
    parent,
    page_size: nil,
    message_types: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size,
    message_types: message_types
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::ListTransferLogsRequest)
  @list_transfer_logs.call(req, options, &block)
end

#list_transfer_runs(parent, states: nil, page_size: nil, run_attempt: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Bigquery::Datatransfer::V1::TransferRun>

Returns information about running and completed jobs.

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_transfer_config_path("[PROJECT]", "[TRANSFER_CONFIG]")

# Iterate over all results.
data_transfer_service_client.list_transfer_runs(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
data_transfer_service_client.list_transfer_runs(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: +projects/{project_id}/transferConfigs/{config_id}+.

  • states (Array<Google::Cloud::Bigquery::Datatransfer::V1::TransferState>) —

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

  • page_size (Integer) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • run_attempt (Google::Cloud::Bigquery::Datatransfer::V1::ListTransferRunsRequest::RunAttempt) —

    Indicates how run attempts are to be pulled.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Cloud::Bigquery::Datatransfer::V1::TransferRun>) —

    An enumerable of Google::Cloud::Bigquery::Datatransfer::V1::TransferRun instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 861

def list_transfer_runs \
    parent,
    states: nil,
    page_size: nil,
    run_attempt: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    states: states,
    page_size: page_size,
    run_attempt: run_attempt
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::ListTransferRunsRequest)
  @list_transfer_runs.call(req, options, &block)
end

#schedule_transfer_runs(parent, start_time, end_time, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Bigquery::Datatransfer::V1::ScheduleTransferRunsResponse

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.

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)
formatted_parent = Google::Cloud::Bigquery::DataTransfer::V1::DataTransferServiceClient.project_transfer_config_path("[PROJECT]", "[TRANSFER_CONFIG]")

# TODO: Initialize +start_time+:
start_time = {}

# TODO: Initialize +end_time+:
end_time = {}
response = data_transfer_service_client.schedule_transfer_runs(formatted_parent, start_time, end_time)

Parameters:

  • parent (String) —

    Transfer configuration name in the form: +projects/{project_id}/transferConfigs/{config_id}+.

  • start_time (Google::Protobuf::Timestamp | Hash) —

    Start time of the range of transfer runs. For example, +"2017-05-25T00:00:00+00:00"+. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • end_time (Google::Protobuf::Timestamp | Hash) —

    End time of the range of transfer runs. For example, +"2017-05-30T00:00:00+00:00"+. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



737
738
739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 737

def schedule_transfer_runs \
    parent,
    start_time,
    end_time,
    options: nil,
    &block
  req = {
    parent: parent,
    start_time: start_time,
    end_time: end_time
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::ScheduleTransferRunsRequest)
  @schedule_transfer_runs.call(req, options, &block)
end

#update_transfer_config(transfer_config, update_mask, authorization_code: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig

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

Examples:

require "google/cloud/bigquery/data_transfer"

data_transfer_service_client = Google::Cloud::Bigquery::DataTransfer.new(version: :v1)

# TODO: Initialize +transfer_config+:
transfer_config = {}

# TODO: Initialize +update_mask+:
update_mask = {}
response = data_transfer_service_client.update_transfer_config(transfer_config, update_mask)

Parameters:

  • transfer_config (Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig | Hash) —

    Data transfer configuration to create. A hash of the same form as Google::Cloud::Bigquery::Datatransfer::V1::TransferConfig can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    Required list of fields to be updated in this request. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • authorization_code (String) —

    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.
  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/google/cloud/bigquery/data_transfer/v1/data_transfer_service_client.rb', line 561

def update_transfer_config \
    transfer_config,
    update_mask,
    authorization_code: nil,
    options: nil,
    &block
  req = {
    transfer_config: transfer_config,
    update_mask: update_mask,
    authorization_code: authorization_code
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Bigquery::Datatransfer::V1::UpdateTransferConfigRequest)
  @update_transfer_config.call(req, options, &block)
end