DataTransferService

google.cloud.bigquery.datatransfer.v1. DataTransferService

Represents a DataTransferService

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

(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

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

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

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

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

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

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

Calls DeleteTransferConfig.

Parameters:
Name Type Description
request google.cloud.bigquery.datatransfer.v1.IDeleteTransferConfigRequest

DeleteTransferConfigRequest message or plain object

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

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

Calls DeleteTransferRun.

Parameters:
Name Type Description
request google.cloud.bigquery.datatransfer.v1.IDeleteTransferRunRequest

DeleteTransferRunRequest message or plain object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Type Definitions

CheckValidCredsCallback(error, responseopt)

Callback as used by google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#deleteTransferRun.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.protobuf.Empty <optional>

Empty

GetDataSourceCallback(error, responseopt)

Callback as used by google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#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 google.cloud.bigquery.datatransfer.v1.DataTransferService#startManualTransferRuns.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse <optional>

StartManualTransferRunsResponse

UpdateTransferConfigCallback(error, responseopt)

Callback as used by google.cloud.bigquery.datatransfer.v1.DataTransferService#updateTransferConfig.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.bigquery.datatransfer.v1.TransferConfig <optional>

TransferConfig