Class: Google::Apis::BigquerydatatransferV1::BigQueryDataTransferService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/bigquerydatatransfer_v1/service.rb

Overview

BigQuery Data Transfer API

Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.

Examples:

require 'google/apis/bigquerydatatransfer_v1'

Bigquerydatatransfer = Google::Apis::BigquerydatatransferV1 # Alias the module
service = Bigquerydatatransfer::BigQueryDataTransferService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeBigQueryDataTransferService

Returns a new instance of BigQueryDataTransferService


46
47
48
49
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 46

def initialize
  super('https://bigquerydatatransfer.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


39
40
41
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 39

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


44
45
46
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#check_project_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::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.

Parameters:

  • name (String)

    The data source in the form: projects/project_id/dataSources/data_source_id``

  • check_valid_creds_request_object (Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


78
79
80
81
82
83
84
85
86
87
88
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 78

def check_project_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:checkValidCreds', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest::Representation
  command.request_object = check_valid_creds_request_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#check_project_location_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::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.

Parameters:

  • name (String)

    The data source in the form: projects/project_id/dataSources/data_source_id``

  • check_valid_creds_request_object (Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


260
261
262
263
264
265
266
267
268
269
270
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 260

def check_project_location_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:checkValidCreds', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsRequest::Representation
  command.request_object = check_valid_creds_request_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferConfig

Creates a new data transfer configuration.

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_object (Google::Apis::BigquerydatatransferV1::TransferConfig) (defaults to: nil)
  • 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=< datatransferapiclientid>&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.
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


387
388
389
390
391
392
393
394
395
396
397
398
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 387

def create_project_location_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}/transferConfigs', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.request_object = transfer_config_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['authorizationCode'] = authorization_code unless authorization_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferConfig

Creates a new data transfer configuration.

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_object (Google::Apis::BigquerydatatransferV1::TransferConfig) (defaults to: nil)
  • 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=< datatransferapiclientid>&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.
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


801
802
803
804
805
806
807
808
809
810
811
812
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 801

def create_project_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}/transferConfigs', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.request_object = transfer_config_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
  command.params['parent'] = parent unless parent.nil?
  command.query['authorizationCode'] = authorization_code unless authorization_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_transfer_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::Empty

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

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


422
423
424
425
426
427
428
429
430
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 422

def delete_project_location_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_transfer_config_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::Empty

Deletes the specified transfer run.

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


626
627
628
629
630
631
632
633
634
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 626

def delete_project_location_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_transfer_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::Empty

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

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


836
837
838
839
840
841
842
843
844
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 836

def delete_project_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_transfer_config_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::Empty

Deletes the specified transfer run.

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1040

def delete_project_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::Empty::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_data_source(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::DataSource

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

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


112
113
114
115
116
117
118
119
120
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 112

def get_project_data_source(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::DataSource::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::DataSource
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::Location

Gets information about a location.

Parameters:

  • name (String)

    Resource name for the location.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


184
185
186
187
188
189
190
191
192
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 184

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::Location::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_data_source(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::DataSource

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

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


294
295
296
297
298
299
300
301
302
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 294

def get_project_location_data_source(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::DataSource::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::DataSource
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_transfer_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferConfig

Returns information about a data transfer config.

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


453
454
455
456
457
458
459
460
461
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 453

def get_project_location_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_transfer_config_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferRun

Returns information about the particular transfer run.

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


657
658
659
660
661
662
663
664
665
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 657

def get_project_location_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::TransferRun::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::TransferRun
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_transfer_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferConfig

Returns information about a data transfer config.

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


867
868
869
870
871
872
873
874
875
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 867

def get_project_transfer_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_transfer_config_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferRun

Returns information about the particular transfer run.

Parameters:

  • name (String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1071

def get_project_transfer_config_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::TransferRun::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::TransferRun
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_data_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse

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

Parameters:

  • parent (String)

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

  • page_size (Fixnum)

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

  • page_token (String)

    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.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


152
153
154
155
156
157
158
159
160
161
162
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 152

def list_project_data_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/dataSources', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_data_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse

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

Parameters:

  • parent (String)

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

  • page_size (Fixnum)

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

  • page_token (String)

    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.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


334
335
336
337
338
339
340
341
342
343
344
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 334

def list_project_location_data_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/dataSources', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListDataSourcesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_transfer_config_run_transfer_logs(parent, message_types: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse

Returns user facing log messages for the data transfer run.

Parameters:

  • parent (String)

    Transfer run name in the form: projects/project_id/transferConfigs/config_Id/runs/run_id``.

  • message_types (Array<String>, String)

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

  • page_size (Fixnum)

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

  • page_token (String)

    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.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


747
748
749
750
751
752
753
754
755
756
757
758
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 747

def list_project_location_transfer_config_run_transfer_logs(parent, message_types: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/transferLogs', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['messageTypes'] = message_types unless message_types.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, states: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse

Returns information about running and completed jobs.

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``.

  • page_size (Fixnum)

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

  • page_token (String)

    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.

  • run_attempt (String)

    Indicates how run attempts are to be pulled.

  • states (Array<String>, String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


701
702
703
704
705
706
707
708
709
710
711
712
713
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 701

def list_project_location_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, states: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/runs', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['runAttempt'] = run_attempt unless run_attempt.nil?
  command.query['states'] = states unless states.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_transfer_configs(parent, data_source_ids: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse

Returns information about all data transfers in the project.

Parameters:

  • parent (String)

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

  • data_source_ids (Array<String>, String)

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

  • page_size (Fixnum)

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

  • page_token (String)

    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.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


494
495
496
497
498
499
500
501
502
503
504
505
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 494

def list_project_location_transfer_configs(parent, data_source_ids: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/transferConfigs', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['dataSourceIds'] = data_source_ids unless data_source_ids.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListLocationsResponse

Lists information about the supported locations for this service.

Parameters:

  • name (String)

    The resource that owns the locations collection, if applicable.

  • filter (String)

    The standard list filter.

  • page_size (Fixnum)

    The standard list page size.

  • page_token (String)

    The standard list page token.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


220
221
222
223
224
225
226
227
228
229
230
231
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 220

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_transfer_config_run_transfer_logs(parent, message_types: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse

Returns user facing log messages for the data transfer run.

Parameters:

  • parent (String)

    Transfer run name in the form: projects/project_id/transferConfigs/config_Id/runs/run_id``.

  • message_types (Array<String>, String)

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

  • page_size (Fixnum)

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

  • page_token (String)

    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.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1161

def list_project_transfer_config_run_transfer_logs(parent, message_types: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/transferLogs', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferLogsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['messageTypes'] = message_types unless message_types.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, states: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse

Returns information about running and completed jobs.

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``.

  • page_size (Fixnum)

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

  • page_token (String)

    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.

  • run_attempt (String)

    Indicates how run attempts are to be pulled.

  • states (Array<String>, String)

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

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1115

def list_project_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, states: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/runs', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferRunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['runAttempt'] = run_attempt unless run_attempt.nil?
  command.query['states'] = states unless states.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_transfer_configs(parent, data_source_ids: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse

Returns information about all data transfers in the project.

Parameters:

  • parent (String)

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

  • data_source_ids (Array<String>, String)

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

  • page_size (Fixnum)

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

  • page_token (String)

    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.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


908
909
910
911
912
913
914
915
916
917
918
919
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 908

def list_project_transfer_configs(parent, data_source_ids: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/transferConfigs', options)
  command.response_representation = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ListTransferConfigsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['dataSourceIds'] = data_source_ids unless data_source_ids.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_transfer_config(name, transfer_config_object = nil, authorization_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferConfig

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

Parameters:

  • name (String)

    The resource name of the transfer config. Transfer config names have the form of projects/project_id/locations/region/transferConfigs/config_id``. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.

  • transfer_config_object (Google::Apis::BigquerydatatransferV1::TransferConfig) (defaults to: nil)
  • 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=< datatransferapiclientid>&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 (String)

    Required list of fields to be updated in this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


554
555
556
557
558
559
560
561
562
563
564
565
566
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 554

def patch_project_location_transfer_config(name, transfer_config_object = nil, authorization_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.request_object = transfer_config_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
  command.params['name'] = name unless name.nil?
  command.query['authorizationCode'] = authorization_code unless authorization_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_transfer_config(name, transfer_config_object = nil, authorization_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferConfig

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

Parameters:

  • name (String)

    The resource name of the transfer config. Transfer config names have the form of projects/project_id/locations/region/transferConfigs/config_id``. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.

  • transfer_config_object (Google::Apis::BigquerydatatransferV1::TransferConfig) (defaults to: nil)
  • 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=< datatransferapiclientid>&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 (String)

    Required list of fields to be updated in this request.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


968
969
970
971
972
973
974
975
976
977
978
979
980
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 968

def patch_project_transfer_config(name, transfer_config_object = nil, authorization_code: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.request_object = transfer_config_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::TransferConfig::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::TransferConfig
  command.params['name'] = name unless name.nil?
  command.query['authorizationCode'] = authorization_code unless authorization_code.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#schedule_project_location_transfer_config_runs(parent, schedule_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::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.

Parameters:

  • parent (String)

    Transfer configuration name in the form: projects/project_id/transferConfigs/config_id``.

  • schedule_transfer_runs_request_object (Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


593
594
595
596
597
598
599
600
601
602
603
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 593

def schedule_project_location_transfer_config_runs(parent, schedule_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}:scheduleRuns', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest::Representation
  command.request_object = schedule_transfer_runs_request_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#schedule_project_transfer_config_runs(parent, schedule_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::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.

Parameters:

  • parent (String)

    Transfer configuration name in the form: projects/project_id/transferConfigs/config_id``.

  • schedule_transfer_runs_request_object (Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1007

def schedule_project_transfer_config_runs(parent, schedule_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}:scheduleRuns', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsRequest::Representation
  command.request_object = schedule_transfer_runs_request_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::ScheduleTransferRunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end