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

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

Overview

BigQuery Data Transfer API

Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.

Examples:

require 'google/apis/bigquerydatatransfer_v1'

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

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ BigQueryDataTransferService

Returns a new instance of BigQueryDataTransferService.



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

def initialize
  super('https://bigquerydatatransfer.googleapis.com/', '',
        client_name: 'google-apis-bigquerydatatransfer_v1',
        client_version: Google::Apis::BigquerydatatransferV1::GEM_VERSION)
  @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 'lib/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 'lib/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) —

    Required. The data source in the form: projects/project_id/dataSources/ data_source_idor `projects/`project_id`/locations/`location_id`/dataSources/ `data_source_id.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 115

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

    Required. The data source in the form: projects/project_id/dataSources/ data_source_idor `projects/`project_id`/locations/`location_id`/dataSources/ `data_source_id.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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, service_account_name: nil, version_info: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferConfig

Creates a new data transfer configuration.

Parameters:

  • parent (String) —

    Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/project_id/locations/location_id or projects/project_id. If specified location and location of the destination bigquery dataset do not match - the request will fail.

  • transfer_config_object (Google::Apis::BigquerydatatransferV1::TransferConfig) (defaults to: nil)
  • authorization_code (String) (defaults to: nil) —

    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/ bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg: oauth:2.0:oob&response_type=authorization_code * 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. Note that this should not be set when service_account_name is used to create the transfer config.

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

    Optional service account name. If this field is set, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/ use-service-accounts

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

    Optional version info. This is required only if transferConfig.dataSourceId is anything else but 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=& scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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. Note that this should not be set when service_account_name is used to create the transfer config.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 473

def create_project_location_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, service_account_name: nil, version_info: 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['serviceAccountName'] =  unless .nil?
  command.query['versionInfo'] = version_info unless version_info.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, service_account_name: nil, version_info: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::TransferConfig

Creates a new data transfer configuration.

Parameters:

  • parent (String) —

    Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/project_id/locations/location_id or projects/project_id. If specified location and location of the destination bigquery dataset do not match - the request will fail.

  • transfer_config_object (Google::Apis::BigquerydatatransferV1::TransferConfig) (defaults to: nil)
  • authorization_code (String) (defaults to: nil) —

    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/ bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg: oauth:2.0:oob&response_type=authorization_code * 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. Note that this should not be set when service_account_name is used to create the transfer config.

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

    Optional service account name. If this field is set, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/ use-service-accounts

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

    Optional version info. This is required only if transferConfig.dataSourceId is anything else but 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=& scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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. Note that this should not be set when service_account_name is used to create the transfer config.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 957

def create_project_transfer_config(parent, transfer_config_object = nil, authorization_code: nil, service_account_name: nil, version_info: 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['serviceAccountName'] =  unless .nil?
  command.query['versionInfo'] = version_info unless version_info.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) —

    Required. The field will contain name of the resource requested, for example: projects/project_id/transferConfigs/config_idor `projects/`project_id`/ locations/`location_id`/transferConfigs/`config_id

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



511
512
513
514
515
516
517
518
519
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 511

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



769
770
771
772
773
774
775
776
777
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 769

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

    Required. The field will contain name of the resource requested, for example: projects/project_id/transferConfigs/config_idor `projects/`project_id`/ locations/`location_id`/transferConfigs/`config_id

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 995

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1253
1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 1253

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

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

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI 'https:// bigquery.cloud.google.com' (and the documents can be found at https://cloud. google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/ working-with-transfers).

Parameters:

  • name (String) —

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

  • enroll_data_sources_request_object (Google::Apis::BigquerydatatransferV1::EnrollDataSourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 226

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

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

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI 'https:// bigquery.cloud.google.com' (and the documents can be found at https://cloud. google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/ working-with-transfers).

Parameters:

  • name (String) —

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

  • enroll_data_sources_request_object (Google::Apis::BigquerydatatransferV1::EnrollDataSourcesRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

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

Parameters:

  • name (String) —

    Required. The field will contain name of the resource requested, for example: projects/project_id/dataSources/data_source_idor `projects/`project_id`/ locations/`location_id`/dataSources/`data_source_id

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



149
150
151
152
153
154
155
156
157
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 149

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) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



258
259
260
261
262
263
264
265
266
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 258

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.

Parameters:

  • name (String) —

    Required. The field will contain name of the resource requested, for example: projects/project_id/dataSources/data_source_idor `projects/`project_id`/ locations/`location_id`/dataSources/`data_source_id

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



369
370
371
372
373
374
375
376
377
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 369

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

    Required. The field will contain name of the resource requested, for example: projects/project_id/transferConfigs/config_idor `projects/`project_id`/ locations/`location_id`/transferConfigs/`config_id

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



543
544
545
546
547
548
549
550
551
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 543

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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

    Required. The field will contain name of the resource requested, for example: projects/project_id/transferConfigs/config_idor `projects/`project_id`/ locations/`location_id`/transferConfigs/`config_id

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 1027

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 1285

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.

Parameters:

  • parent (String) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 188

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.

Parameters:

  • parent (String) —

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 408

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 log messages for the transfer run.

Parameters:

  • parent (String) —

    Required. Transfer run name in the form: projects/project_id/ transferConfigs/config_id/runs/run_idor `projects/`project_id`/locations/ `location_id`/transferConfigs/`config_id`/runs/`run_id

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 891

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 transfer runs.

Parameters:

  • parent (String) —

    Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/ project_id/transferConfigs/config_idor `projects/`project_id`/locations/` location_id`/transferConfigs/`config_id.

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

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

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

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

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

    Indicates how run attempts are to be pulled.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 845

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 transfer configs owned by a project in the specified location.

Parameters:

  • parent (String) —

    Required. The BigQuery project id for which transfer configs should be returned: projects/project_idor `projects/`project_id`/locations/` location_id

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 585

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) (defaults to: nil) —

    A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.

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

    The maximum number of results to return. If not set, the service selects a default.

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

    A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 298

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 log messages for the transfer run.

Parameters:

  • parent (String) —

    Required. Transfer run name in the form: projects/project_id/ transferConfigs/config_id/runs/run_idor `projects/`project_id`/locations/ `location_id`/transferConfigs/`config_id`/runs/`run_id

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 1375

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 transfer runs.

Parameters:

  • parent (String) —

    Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/ project_id/transferConfigs/config_idor `projects/`project_id`/locations/` location_id`/transferConfigs/`config_id.

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

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

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

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

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

    Indicates how run attempts are to be pulled.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 1329

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 transfer configs owned by a project in the specified location.

Parameters:

  • parent (String) —

    Required. The BigQuery project id for which transfer configs should be returned: projects/project_idor `projects/`project_id`/locations/` location_id

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

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

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

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



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

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, service_account_name: nil, update_mask: nil, version_info: 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 projects/project_id/locations/region/transferConfigs/config_id`. Where config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

  • transfer_config_object (Google::Apis::BigquerydatatransferV1::TransferConfig) (defaults to: nil)
  • authorization_code (String) (defaults to: nil) —

    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/ bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg: oauth:2.0:oob&response_type=authorization_code * 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. Note that this should not be set when service_account_name is used to create the transfer config.

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

    Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service- accounts

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

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

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

    Optional version info. This is required only if transferConfig.dataSourceId is anything else but 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=& scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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. Note that this should not be set when service_account_name is used to create the transfer config.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 655

def patch_project_location_transfer_config(name, transfer_config_object = nil, authorization_code: nil, service_account_name: nil, update_mask: nil, version_info: 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['serviceAccountName'] =  unless .nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['versionInfo'] = version_info unless version_info.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, service_account_name: nil, update_mask: nil, version_info: 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 projects/project_id/locations/region/transferConfigs/config_id`. Where config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

  • transfer_config_object (Google::Apis::BigquerydatatransferV1::TransferConfig) (defaults to: nil)
  • authorization_code (String) (defaults to: nil) —

    Optional OAuth2 authorization code to use with this transfer configuration. This is required only if transferConfig.dataSourceId is 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/ bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri=urn:ietf:wg: oauth:2.0:oob&response_type=authorization_code * 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. Note that this should not be set when service_account_name is used to create the transfer config.

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

    Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be created with this service account credential. It requires that requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating transfer config. Please refer to this public guide for the latest list of data sources with service account support: https://cloud.google.com/bigquery-transfer/docs/use-service- accounts

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

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

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

    Optional version info. This is required only if transferConfig.dataSourceId is anything else but 'youtube_channel' and new credentials are needed, as indicated by CheckValidCreds. In order to obtain version info, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=& scope=&redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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. Note that this should not be set when service_account_name is used to create the transfer config.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 1139

def patch_project_transfer_config(name, transfer_config_object = nil, authorization_code: nil, service_account_name: nil, update_mask: nil, version_info: 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['serviceAccountName'] =  unless .nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['versionInfo'] = version_info unless version_info.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. DEPRECATED: use StartManualTransferRuns instead.

Parameters:

  • parent (String) —

    Required. Transfer configuration name in the form: projects/project_id/ transferConfigs/config_idor `projects/`project_id`/locations/`location_id`/ transferConfigs/`config_id.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 697

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. DEPRECATED: use StartManualTransferRuns instead.

Parameters:

  • parent (String) —

    Required. Transfer configuration name in the form: projects/project_id/ transferConfigs/config_idor `projects/`project_id`/locations/`location_id`/ transferConfigs/`config_id.

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

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 1181

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

#start_project_location_transfer_config_manual_runs(parent, start_manual_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse

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

Parameters:

  • parent (String) —

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

  • start_manual_transfer_runs_request_object (Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 735

def start_project_location_transfer_config_manual_runs(parent, start_manual_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:startManualRuns', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest::Representation
  command.request_object = start_manual_transfer_runs_request_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse
  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

#start_project_transfer_config_manual_runs(parent, start_manual_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse

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

Parameters:

  • parent (String) —

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

  • start_manual_transfer_runs_request_object (Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    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) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/google/apis/bigquerydatatransfer_v1/service.rb', line 1219

def start_project_transfer_config_manual_runs(parent, start_manual_transfer_runs_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}:startManualRuns', options)
  command.request_representation = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsRequest::Representation
  command.request_object = start_manual_transfer_runs_request_object
  command.response_representation = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse::Representation
  command.response_class = Google::Apis::BigquerydatatransferV1::StartManualTransferRunsResponse
  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