DataTransferServiceClient

DataTransferServiceClient

The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. This service contains methods that are end user exposed. It backs up the frontend.

Constructor

new DataTransferServiceClient(optionsopt)

Construct an instance of DataTransferServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. See the subsequent parameters for more details.

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

Members

(static) apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

(static) port

The port for this API service.

(static) scopes

The scopes needed to make gRPC calls for every method defined in this service.

(static) servicePath

The DNS address for this API service.

Methods

checkValidCreds(request, optionsopt) → {Promise}

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 Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

options object <optional>

Call options. See CallOptions for more details.

close()

Terminate the GRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

createTransferConfig(request, optionsopt) → {Promise}

Creates a new data transfer configuration.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
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.

transferConfig google.cloud.bigquery.datatransfer.v1.TransferConfig

Required. Data transfer configuration to create.

authorizationCode string

Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=<data_source_scopes>&redirect_uri=<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.
versionInfo string

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.

serviceAccountName string

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.

options object <optional>

Call options. See CallOptions for more details.

deleteTransferConfig(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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

options object <optional>

Call options. See CallOptions for more details.

deleteTransferRun(request, optionsopt) → {Promise}

Deletes the specified transfer run.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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

options object <optional>

Call options. See CallOptions for more details.

getDataSource(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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

options object <optional>

Call options. See CallOptions for more details.

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.

getTransferConfig(request, optionsopt) → {Promise}

Returns information about a data transfer config.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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

options object <optional>

Call options. See CallOptions for more details.

getTransferRun(request, optionsopt) → {Promise}

Returns information about the particular transfer run.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

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

options object <optional>

Call options. See CallOptions for more details.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

listDataSources(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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

pageToken string

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

pageSize number

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

options object <optional>

Call options. See CallOptions for more details.

listDataSourcesAsync(request, optionsopt) → {Object}

Equivalent to listDataSources, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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

pageToken string

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

pageSize number

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

options object <optional>

Call options. See CallOptions for more details.

listDataSourcesStream(request, optionsopt) → {Stream}

Equivalent to listDataSources, but returns a NodeJS Stream object.

This fetches the paged responses for listDataSources continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

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

pageToken string

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

pageSize number

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

options object <optional>

Call options. See CallOptions for more details.

See:

listTransferConfigs(request, optionsopt) → {Promise}

Returns information about all data transfers in the project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

dataSourceIds Array.<string>

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

pageToken string

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

pageSize number

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

options object <optional>

Call options. See CallOptions for more details.

listTransferConfigsAsync(request, optionsopt) → {Object}

Equivalent to listTransferConfigs, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

dataSourceIds Array.<string>

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

pageToken string

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

pageSize number

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

options object <optional>

Call options. See CallOptions for more details.

listTransferConfigsStream(request, optionsopt) → {Stream}

Equivalent to listTransferConfigs, but returns a NodeJS Stream object.

This fetches the paged responses for listTransferConfigs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

dataSourceIds Array.<string>

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

pageToken string

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

pageSize number

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

options object <optional>

Call options. See CallOptions for more details.

See:

listTransferLogs(request, optionsopt) → {Promise}

Returns user facing log messages for the data transfer run.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

pageToken string

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

pageSize number

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

messageTypes Array.<number>

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

options object <optional>

Call options. See CallOptions for more details.

listTransferLogsAsync(request, optionsopt) → {Object}

Equivalent to listTransferLogs, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

pageToken string

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

pageSize number

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

messageTypes Array.<number>

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

options object <optional>

Call options. See CallOptions for more details.

listTransferLogsStream(request, optionsopt) → {Stream}

Equivalent to listTransferLogs, but returns a NodeJS Stream object.

This fetches the paged responses for listTransferLogs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

pageToken string

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

pageSize number

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

messageTypes Array.<number>

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

options object <optional>

Call options. See CallOptions for more details.

See:

listTransferRuns(request, optionsopt) → {Promise}

Returns information about running and completed jobs.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
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_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

states Array.<number>

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

pageToken string

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

pageSize number

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

runAttempt google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt

Indicates how run attempts are to be pulled.

options object <optional>

Call options. See CallOptions for more details.

listTransferRunsAsync(request, optionsopt) → {Object}

Equivalent to listTransferRuns, but returns an iterable object.

for-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
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_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

states Array.<number>

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

pageToken string

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

pageSize number

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

runAttempt google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt

Indicates how run attempts are to be pulled.

options object <optional>

Call options. See CallOptions for more details.

listTransferRunsStream(request, optionsopt) → {Stream}

Equivalent to listTransferRuns, but returns a NodeJS Stream object.

This fetches the paged responses for listTransferRuns continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
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_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

states Array.<number>

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

pageToken string

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

pageSize number

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

runAttempt google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.RunAttempt

Indicates how run attempts are to be pulled.

options object <optional>

Call options. See CallOptions for more details.

See:

matchDataSourceFromProjectDataSourceName(projectDataSourceName) → {string}

Parse the data_source from ProjectDataSource resource.

Parameters:
Name Type Description
projectDataSourceName string

A fully-qualified path representing project_data_source resource.

matchDataSourceFromProjectLocationDataSourceName(projectLocationDataSourceName) → {string}

Parse the data_source from ProjectLocationDataSource resource.

Parameters:
Name Type Description
projectLocationDataSourceName string

A fully-qualified path representing project_location_data_source resource.

matchLocationFromProjectLocationDataSourceName(projectLocationDataSourceName) → {string}

Parse the location from ProjectLocationDataSource resource.

Parameters:
Name Type Description
projectLocationDataSourceName string

A fully-qualified path representing project_location_data_source resource.

matchLocationFromProjectLocationTransferConfigName(projectLocationTransferConfigName) → {string}

Parse the location from ProjectLocationTransferConfig resource.

Parameters:
Name Type Description
projectLocationTransferConfigName string

A fully-qualified path representing project_location_transfer_config resource.

matchLocationFromProjectLocationTransferConfigRunName(projectLocationTransferConfigRunName) → {string}

Parse the location from ProjectLocationTransferConfigRun resource.

Parameters:
Name Type Description
projectLocationTransferConfigRunName string

A fully-qualified path representing project_location_transfer_config_run resource.

matchProjectFromProjectDataSourceName(projectDataSourceName) → {string}

Parse the project from ProjectDataSource resource.

Parameters:
Name Type Description
projectDataSourceName string

A fully-qualified path representing project_data_source resource.

matchProjectFromProjectLocationDataSourceName(projectLocationDataSourceName) → {string}

Parse the project from ProjectLocationDataSource resource.

Parameters:
Name Type Description
projectLocationDataSourceName string

A fully-qualified path representing project_location_data_source resource.

matchProjectFromProjectLocationTransferConfigName(projectLocationTransferConfigName) → {string}

Parse the project from ProjectLocationTransferConfig resource.

Parameters:
Name Type Description
projectLocationTransferConfigName string

A fully-qualified path representing project_location_transfer_config resource.

matchProjectFromProjectLocationTransferConfigRunName(projectLocationTransferConfigRunName) → {string}

Parse the project from ProjectLocationTransferConfigRun resource.

Parameters:
Name Type Description
projectLocationTransferConfigRunName string

A fully-qualified path representing project_location_transfer_config_run resource.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

A fully-qualified path representing Project resource.

matchProjectFromProjectTransferConfigName(projectTransferConfigName) → {string}

Parse the project from ProjectTransferConfig resource.

Parameters:
Name Type Description
projectTransferConfigName string

A fully-qualified path representing project_transfer_config resource.

matchProjectFromProjectTransferConfigRunName(projectTransferConfigRunName) → {string}

Parse the project from ProjectTransferConfigRun resource.

Parameters:
Name Type Description
projectTransferConfigRunName string

A fully-qualified path representing project_transfer_config_run resource.

matchRunFromProjectLocationTransferConfigRunName(projectLocationTransferConfigRunName) → {string}

Parse the run from ProjectLocationTransferConfigRun resource.

Parameters:
Name Type Description
projectLocationTransferConfigRunName string

A fully-qualified path representing project_location_transfer_config_run resource.

matchRunFromProjectTransferConfigRunName(projectTransferConfigRunName) → {string}

Parse the run from ProjectTransferConfigRun resource.

Parameters:
Name Type Description
projectTransferConfigRunName string

A fully-qualified path representing project_transfer_config_run resource.

matchTransferConfigFromProjectLocationTransferConfigName(projectLocationTransferConfigName) → {string}

Parse the transfer_config from ProjectLocationTransferConfig resource.

Parameters:
Name Type Description
projectLocationTransferConfigName string

A fully-qualified path representing project_location_transfer_config resource.

matchTransferConfigFromProjectLocationTransferConfigRunName(projectLocationTransferConfigRunName) → {string}

Parse the transfer_config from ProjectLocationTransferConfigRun resource.

Parameters:
Name Type Description
projectLocationTransferConfigRunName string

A fully-qualified path representing project_location_transfer_config_run resource.

matchTransferConfigFromProjectTransferConfigName(projectTransferConfigName) → {string}

Parse the transfer_config from ProjectTransferConfig resource.

Parameters:
Name Type Description
projectTransferConfigName string

A fully-qualified path representing project_transfer_config resource.

matchTransferConfigFromProjectTransferConfigRunName(projectTransferConfigRunName) → {string}

Parse the transfer_config from ProjectTransferConfigRun resource.

Parameters:
Name Type Description
projectTransferConfigRunName string

A fully-qualified path representing project_transfer_config_run resource.

projectDataSourcePath(project, data_source) → {string}

Return a fully-qualified projectDataSource resource name string.

Parameters:
Name Type Description
project string
data_source string

projectLocationDataSourcePath(project, location, data_source) → {string}

Return a fully-qualified projectLocationDataSource resource name string.

Parameters:
Name Type Description
project string
location string
data_source string

projectLocationTransferConfigPath(project, location, transfer_config) → {string}

Return a fully-qualified projectLocationTransferConfig resource name string.

Parameters:
Name Type Description
project string
location string
transfer_config string

projectLocationTransferConfigRunPath(project, location, transfer_config, run) → {string}

Return a fully-qualified projectLocationTransferConfigRun resource name string.

Parameters:
Name Type Description
project string
location string
transfer_config string
run string

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project string

projectTransferConfigPath(project, transfer_config) → {string}

Return a fully-qualified projectTransferConfig resource name string.

Parameters:
Name Type Description
project string
transfer_config string

projectTransferConfigRunPath(project, transfer_config, run) → {string}

Return a fully-qualified projectTransferConfigRun resource name string.

Parameters:
Name Type Description
project string
transfer_config string
run string

scheduleTransferRuns(request, optionsopt) → {Promise}

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:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

startTime google.protobuf.Timestamp

Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".

endTime google.protobuf.Timestamp

Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".

options object <optional>

Call options. See CallOptions for more details.

startManualTransferRuns(request, optionsopt) → {Promise}

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:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

requestedTimeRange google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange

Time range for the transfer runs that should be started.

requestedRunTime google.protobuf.Timestamp

Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.

options object <optional>

Call options. See CallOptions for more details.

updateTransferConfig(request, optionsopt) → {Promise}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
transferConfig google.cloud.bigquery.datatransfer.v1.TransferConfig

Required. Data transfer configuration to create.

authorizationCode string

Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=<data_source_scopes>&redirect_uri=<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.
updateMask google.protobuf.FieldMask

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

versionInfo string

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.

serviceAccountName string

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.

options object <optional>

Call options. See CallOptions for more details.