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

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

Overview

BigQuery Data Transfer API

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

#initializeBigQueryDataTransferService

Returns a new instance of BigQueryDataTransferService.



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

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

Instance Attribute Details

#keyString

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

Returns:

  • (String)

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



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

def key
  @key
end

#quota_userString

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

Returns:

  • (String)

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



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

def quota_user
  @quota_user
end

Instance Method Details

#check_project_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse

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

Parameters:

  • name (String)

    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



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

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

#check_project_location_data_source_valid_creds(name, check_valid_creds_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::BigquerydatatransferV1::CheckValidCredsResponse

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

Parameters:

  • name (String)

    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



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

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 if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=& redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

  • service_account_name (String) (defaults to: nil)

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

  • version_info (String) (defaults to: nil)

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

  • 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



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

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 if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=& redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

  • service_account_name (String) (defaults to: nil)

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

  • version_info (String) (defaults to: nil)

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

  • 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



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

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



433
434
435
436
437
438
439
440
441
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 433

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



685
686
687
688
689
690
691
692
693
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 685

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



905
906
907
908
909
910
911
912
913
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 905

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



1157
1158
1159
1160
1161
1162
1163
1164
1165
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1157

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)

    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



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

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



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

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)

    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



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

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



465
466
467
468
469
470
471
472
473
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 465

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



717
718
719
720
721
722
723
724
725
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 717

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



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

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



1189
1190
1191
1192
1193
1194
1195
1196
1197
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1189

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

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

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

Parameters:

  • parent (String)

    Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/project_id`orprojects/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



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

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)

    Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/project_id`orprojects/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



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

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)

    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



807
808
809
810
811
812
813
814
815
816
817
818
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 807

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

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

Returns information about running and completed jobs.

Parameters:

  • parent (String)

    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



761
762
763
764
765
766
767
768
769
770
771
772
773
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 761

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

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

Returns information about all data transfers in the project.

Parameters:

  • parent (String)

    Required. The BigQuery project id for which data sources 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



505
506
507
508
509
510
511
512
513
514
515
516
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 505

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)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • 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



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

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)

    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



1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1279

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

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

Returns information about running and completed jobs.

Parameters:

  • parent (String)

    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



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1233

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

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

Returns information about all data transfers in the project.

Parameters:

  • parent (String)

    Required. The BigQuery project id for which data sources 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



977
978
979
980
981
982
983
984
985
986
987
988
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 977

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 of projects/project_id/locations/region/transferConfigs/config_id``. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.

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

    Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=& redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

  • service_account_name (String) (defaults to: nil)

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

  • 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. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the " none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

  • 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



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 571

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 of projects/project_id/locations/region/transferConfigs/config_id``. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.

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

    Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=& redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

  • service_account_name (String) (defaults to: nil)

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

  • 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. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the " none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.

  • 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



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

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



613
614
615
616
617
618
619
620
621
622
623
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 613

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



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1085

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



651
652
653
654
655
656
657
658
659
660
661
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 651

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



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
# File 'generated/google/apis/bigquerydatatransfer_v1/service.rb', line 1123

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