DataTransferService - Documentation

Constructor

new DataTransferService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new DataTransferService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

checkValidCreds(request, callback) → {undefined}

Calls CheckValidCreds.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.ICheckValidCredsRequest	CheckValidCredsRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.CheckValidCredsCallback	Node-style callback called with the error, if any, and CheckValidCredsResponse

Returns:

Type	Description
undefined

checkValidCreds(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse>}

Calls CheckValidCreds.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.ICheckValidCredsRequest	CheckValidCredsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse>	Promise

createTransferConfig(request, callback) → {undefined}

Calls CreateTransferConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest	CreateTransferConfigRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.CreateTransferConfigCallback	Node-style callback called with the error, if any, and TransferConfig

Returns:

Type	Description
undefined

createTransferConfig(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.TransferConfig>}

Calls CreateTransferConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest	CreateTransferConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.TransferConfig>	Promise

deleteTransferConfig(request, callback) → {undefined}

Calls DeleteTransferConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IDeleteTransferConfigRequest	DeleteTransferConfigRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferConfigCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteTransferConfig(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteTransferConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IDeleteTransferConfigRequest	DeleteTransferConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

deleteTransferRun(request, callback) → {undefined}

Calls DeleteTransferRun.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IDeleteTransferRunRequest	DeleteTransferRunRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferRunCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteTransferRun(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteTransferRun.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IDeleteTransferRunRequest	DeleteTransferRunRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

enrollDataSources(request, callback) → {undefined}

Calls EnrollDataSources.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IEnrollDataSourcesRequest	EnrollDataSourcesRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.EnrollDataSourcesCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

enrollDataSources(request) → {Promise.<google.protobuf.Empty>}

Calls EnrollDataSources.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IEnrollDataSourcesRequest	EnrollDataSourcesRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

getDataSource(request, callback) → {undefined}

Calls GetDataSource.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest	GetDataSourceRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.GetDataSourceCallback	Node-style callback called with the error, if any, and DataSource

Returns:

Type	Description
undefined

getDataSource(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.DataSource>}

Calls GetDataSource.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest	GetDataSourceRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.DataSource>	Promise

getTransferConfig(request, callback) → {undefined}

Calls GetTransferConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IGetTransferConfigRequest	GetTransferConfigRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferConfigCallback	Node-style callback called with the error, if any, and TransferConfig

Returns:

Type	Description
undefined

getTransferConfig(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.TransferConfig>}

Calls GetTransferConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IGetTransferConfigRequest	GetTransferConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.TransferConfig>	Promise

getTransferRun(request, callback) → {undefined}

Calls GetTransferRun.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IGetTransferRunRequest	GetTransferRunRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferRunCallback	Node-style callback called with the error, if any, and TransferRun

Returns:

Type	Description
undefined

getTransferRun(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.TransferRun>}

Calls GetTransferRun.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IGetTransferRunRequest	GetTransferRunRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.TransferRun>	Promise

listDataSources(request, callback) → {undefined}

Calls ListDataSources.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IListDataSourcesRequest	ListDataSourcesRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.ListDataSourcesCallback	Node-style callback called with the error, if any, and ListDataSourcesResponse

Returns:

Type	Description
undefined

listDataSources(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse>}

Calls ListDataSources.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IListDataSourcesRequest	ListDataSourcesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse>	Promise

listTransferConfigs(request, callback) → {undefined}

Calls ListTransferConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IListTransferConfigsRequest	ListTransferConfigsRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferConfigsCallback	Node-style callback called with the error, if any, and ListTransferConfigsResponse

Returns:

Type	Description
undefined

listTransferConfigs(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse>}

Calls ListTransferConfigs.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IListTransferConfigsRequest	ListTransferConfigsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse>	Promise

listTransferLogs(request, callback) → {undefined}

Calls ListTransferLogs.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IListTransferLogsRequest	ListTransferLogsRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferLogsCallback	Node-style callback called with the error, if any, and ListTransferLogsResponse

Returns:

Type	Description
undefined

listTransferLogs(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse>}

Calls ListTransferLogs.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IListTransferLogsRequest	ListTransferLogsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse>	Promise

listTransferRuns(request, callback) → {undefined}

Calls ListTransferRuns.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IListTransferRunsRequest	ListTransferRunsRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferRunsCallback	Node-style callback called with the error, if any, and ListTransferRunsResponse

Returns:

Type	Description
undefined

listTransferRuns(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse>}

Calls ListTransferRuns.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IListTransferRunsRequest	ListTransferRunsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse>	Promise

scheduleTransferRuns(request, callback) → {undefined}

Calls ScheduleTransferRuns.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IScheduleTransferRunsRequest	ScheduleTransferRunsRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.ScheduleTransferRunsCallback	Node-style callback called with the error, if any, and ScheduleTransferRunsResponse

Returns:

Type	Description
undefined

scheduleTransferRuns(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse>}

Calls ScheduleTransferRuns.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IScheduleTransferRunsRequest	ScheduleTransferRunsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse>	Promise

startManualTransferRuns(request, callback) → {undefined}

Calls StartManualTransferRuns.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IStartManualTransferRunsRequest	StartManualTransferRunsRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.StartManualTransferRunsCallback	Node-style callback called with the error, if any, and StartManualTransferRunsResponse

Returns:

Type	Description
undefined

startManualTransferRuns(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse>}

Calls StartManualTransferRuns.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IStartManualTransferRunsRequest	StartManualTransferRunsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse>	Promise

unenrollDataSources(request, callback) → {undefined}

Calls UnenrollDataSources.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IUnenrollDataSourcesRequest	UnenrollDataSourcesRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.UnenrollDataSourcesCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

unenrollDataSources(request) → {Promise.<google.protobuf.Empty>}

Calls UnenrollDataSources.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IUnenrollDataSourcesRequest	UnenrollDataSourcesRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

updateTransferConfig(request, callback) → {undefined}

Calls UpdateTransferConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IUpdateTransferConfigRequest	UpdateTransferConfigRequest message or plain object
`callback`	google.cloud.bigquery.datatransfer.v1.DataTransferService.UpdateTransferConfigCallback	Node-style callback called with the error, if any, and TransferConfig

Returns:

Type	Description
undefined

updateTransferConfig(request) → {Promise.<google.cloud.bigquery.datatransfer.v1.TransferConfig>}

Calls UpdateTransferConfig.

Parameters:

Name	Type	Description
`request`	google.cloud.bigquery.datatransfer.v1.IUpdateTransferConfigRequest	UpdateTransferConfigRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.bigquery.datatransfer.v1.TransferConfig>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {DataTransferService}

Creates new DataTransferService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
DataTransferService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CheckValidCredsCallback(error, responseopt)

Callback as used by checkValidCreds.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse	<optional>	CheckValidCredsResponse

CreateTransferConfigCallback(error, responseopt)

Callback as used by createTransferConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.TransferConfig	<optional>	TransferConfig

DeleteTransferConfigCallback(error, responseopt)

Callback as used by deleteTransferConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DeleteTransferRunCallback(error, responseopt)

Callback as used by deleteTransferRun.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

EnrollDataSourcesCallback(error, responseopt)

Callback as used by enrollDataSources.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

GetDataSourceCallback(error, responseopt)

Callback as used by getDataSource.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.DataSource	<optional>	DataSource

GetTransferConfigCallback(error, responseopt)

Callback as used by getTransferConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.TransferConfig	<optional>	TransferConfig

GetTransferRunCallback(error, responseopt)

Callback as used by getTransferRun.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.TransferRun	<optional>	TransferRun

ListDataSourcesCallback(error, responseopt)

Callback as used by listDataSources.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse	<optional>	ListDataSourcesResponse

ListTransferConfigsCallback(error, responseopt)

Callback as used by listTransferConfigs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse	<optional>	ListTransferConfigsResponse

ListTransferLogsCallback(error, responseopt)

Callback as used by listTransferLogs.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse	<optional>	ListTransferLogsResponse

ListTransferRunsCallback(error, responseopt)

Callback as used by listTransferRuns.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse	<optional>	ListTransferRunsResponse

ScheduleTransferRunsCallback(error, responseopt)

Callback as used by scheduleTransferRuns.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse	<optional>	ScheduleTransferRunsResponse

StartManualTransferRunsCallback(error, responseopt)

Callback as used by startManualTransferRuns.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse	<optional>	StartManualTransferRunsResponse

UnenrollDataSourcesCallback(error, responseopt)

Callback as used by unenrollDataSources.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

UpdateTransferConfigCallback(error, responseopt)

Callback as used by updateTransferConfig.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.bigquery.datatransfer.v1.TransferConfig	<optional>	TransferConfig