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

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

Overview

BigQuery Data Transfer Service 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

#initialize ⇒ BigQueryDataTransferService

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

#key ⇒ String

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_user ⇒ String

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.

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:



145
146
147
148
149
150
151
152
153
154
155
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 145

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.

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:



394
395
396
397
398
399
400
401
402
403
404
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 394

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 or /projects/project_id/locations/- In case when '-' is specified as location_id, location is infered from the destination dataset region.

  • 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:



523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 523

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 or /projects/project_id/locations/- In case when '-' is specified as location_id, location is infered from the destination dataset region.

  • 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:



937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 937

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:



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

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:



760
761
762
763
764
765
766
767
768
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 760

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:



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

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:



1174
1175
1176
1177
1178
1179
1180
1181
1182
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1174

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:



179
180
181
182
183
184
185
186
187
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 179

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

Get 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:



251
252
253
254
255
256
257
258
259
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 251

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:



428
429
430
431
432
433
434
435
436
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 428

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:



589
590
591
592
593
594
595
596
597
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 589

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:



791
792
793
794
795
796
797
798
799
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 791

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:



1003
1004
1005
1006
1007
1008
1009
1010
1011
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1003

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:



1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1205

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

#is_location_enabled(name, is_enabled_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::IsEnabledResponse

Returns true if data transfer is enabled for a project.

Parameters:

  • name (String) —

    The name of the project resource in the form: projects/project_id``

  • is_enabled_request_object (Google::Apis::BigquerydatatransferV1::IsEnabledRequest) (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:



283
284
285
286
287
288
289
290
291
292
293
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 283

def is_location_enabled(name, is_enabled_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:isEnabled', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::IsEnabledRequest::Representation
  command.request_object = is_enabled_request_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::IsEnabledResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::IsEnabledResponse
  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

#is_project_enabled(name, is_enabled_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::IsEnabledResponse

Returns true if data transfer is enabled for a project.

Parameters:

  • name (String) —

    The name of the project resource in the form: projects/project_id``

  • is_enabled_request_object (Google::Apis::BigquerydatatransferV1::IsEnabledRequest) (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:



73
74
75
76
77
78
79
80
81
82
83
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 73

def is_project_enabled(name, is_enabled_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:isEnabled', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::IsEnabledRequest::Representation
  command.request_object = is_enabled_request_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::IsEnabledResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::IsEnabledResponse
  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:



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

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:



468
469
470
471
472
473
474
475
476
477
478
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 468

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:



881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 881

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, statuses: 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.

  • statuses (Array<String>, String) —

    When specified, only transfer runs with requested statuses 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:



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

def list_project_location_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, statuses: 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['statuses'] = statuses unless statuses.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:



630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 630

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:



321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 321

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:



1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1295

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, statuses: 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.

  • statuses (Array<String>, String) —

    When specified, only transfer runs with requested statuses 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:



1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1249

def list_project_transfer_config_runs(parent, page_size: nil, page_token: nil, run_attempt: nil, statuses: 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['statuses'] = statuses unless statuses.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:



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1044

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 run. Transfer run names have the form projects/project_id/transferConfigs/config_id`. Whereconfig_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer run.

  • 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 gaia id of 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:



688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 688

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 run. Transfer run names have the form projects/project_id/transferConfigs/config_id`. Whereconfig_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer run.

  • 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 gaia id of 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:



1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1102

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 [range_start_time, range_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:



727
728
729
730
731
732
733
734
735
736
737
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 727

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 [range_start_time, range_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:



1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1141

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

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

Enables or disables data transfer for a project. This method requires the additional scope of 'https://www.googleapis.com/auth/cloudplatformprojects' to manage the cloud project permissions.

Parameters:

  • name (String) —

    The name of the project resource in the form: projects/project_id``

  • set_enabled_request_object (Google::Apis::BigquerydatatransferV1::SetEnabledRequest) (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:



359
360
361
362
363
364
365
366
367
368
369
 
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 359

def set_location_enabled(name, set_enabled_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:setEnabled', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::SetEnabledRequest::Representation
  command.request_object = set_enabled_request_object
  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

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

Enables or disables data transfer for a project. This method requires the additional scope of 'https://www.googleapis.com/auth/cloudplatformprojects' to manage the cloud project permissions.

Parameters:

  • name (String) —

    The name of the project resource in the form: projects/project_id``

  • set_enabled_request_object (Google::Apis::BigquerydatatransferV1::SetEnabledRequest) (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:



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

def set_project_enabled(name, set_enabled_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:setEnabled', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::SetEnabledRequest::Representation
  command.request_object = set_enabled_request_object
  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