Class protos.google.cloud.bigquery.datatransfer.v1.DataTransferService (3.2.2)

Version latest

• 3.2.2 (latest)
• 3.2.1
• 3.1.5
• 2.3.0
• 2.2.7

Represents a DataTransferService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.bigquery.datatransfer.v1.DataTransferService

Package

@google-cloud/bigquery-data-transfer

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new DataTransferService service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

checkValidCreds(request, callback)

public checkValidCreds(request: google.cloud.bigquery.datatransfer.v1.ICheckValidCredsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.CheckValidCredsCallback): void;

Calls CheckValidCreds.

Parameters
Name	Description
request	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
void

checkValidCreds(request)

public checkValidCreds(request: google.cloud.bigquery.datatransfer.v1.ICheckValidCredsRequest): Promise<google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse>;

Calls CheckValidCreds.

Parameter
Name	Description
request	ICheckValidCredsRequest CheckValidCredsRequest message or plain object

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

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): DataTransferService;

Creates new DataTransferService service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

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

createTransferConfig(request, callback)

public createTransferConfig(request: google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.CreateTransferConfigCallback): void;

Calls CreateTransferConfig.

Parameters
Name	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
void

createTransferConfig(request)

public createTransferConfig(request: google.cloud.bigquery.datatransfer.v1.ICreateTransferConfigRequest): Promise<google.cloud.bigquery.datatransfer.v1.TransferConfig>;

Calls CreateTransferConfig.

Parameter
Name	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)

public deleteTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IDeleteTransferConfigRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferConfigCallback): void;

Calls DeleteTransferConfig.

Parameters
Name	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
void

deleteTransferConfig(request)

public deleteTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IDeleteTransferConfigRequest): Promise<google.protobuf.Empty>;

Calls DeleteTransferConfig.

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

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

deleteTransferRun(request, callback)

public deleteTransferRun(request: google.cloud.bigquery.datatransfer.v1.IDeleteTransferRunRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.DeleteTransferRunCallback): void;

Calls DeleteTransferRun.

Parameters
Name	Description
request	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
void

deleteTransferRun(request)

public deleteTransferRun(request: google.cloud.bigquery.datatransfer.v1.IDeleteTransferRunRequest): Promise<google.protobuf.Empty>;

Calls DeleteTransferRun.

Parameter
Name	Description
request	IDeleteTransferRunRequest DeleteTransferRunRequest message or plain object

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

enrollDataSources(request, callback)

public enrollDataSources(request: google.cloud.bigquery.datatransfer.v1.IEnrollDataSourcesRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.EnrollDataSourcesCallback): void;

Calls EnrollDataSources.

Parameters
Name	Description
request	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
void

enrollDataSources(request)

public enrollDataSources(request: google.cloud.bigquery.datatransfer.v1.IEnrollDataSourcesRequest): Promise<google.protobuf.Empty>;

Calls EnrollDataSources.

Parameter
Name	Description
request	IEnrollDataSourcesRequest EnrollDataSourcesRequest message or plain object

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

getDataSource(request, callback)

public getDataSource(request: google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.GetDataSourceCallback): void;

Calls GetDataSource.

Parameters
Name	Description
request	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
void

getDataSource(request)

public getDataSource(request: google.cloud.bigquery.datatransfer.v1.IGetDataSourceRequest): Promise<google.cloud.bigquery.datatransfer.v1.DataSource>;

Calls GetDataSource.

Parameter
Name	Description
request	IGetDataSourceRequest GetDataSourceRequest message or plain object

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

getTransferConfig(request, callback)

public getTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IGetTransferConfigRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferConfigCallback): void;

Calls GetTransferConfig.

Parameters
Name	Description
request	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
void

getTransferConfig(request)

public getTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IGetTransferConfigRequest): Promise<google.cloud.bigquery.datatransfer.v1.TransferConfig>;

Calls GetTransferConfig.

Parameter
Name	Description
request	IGetTransferConfigRequest GetTransferConfigRequest message or plain object

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

getTransferRun(request, callback)

public getTransferRun(request: google.cloud.bigquery.datatransfer.v1.IGetTransferRunRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.GetTransferRunCallback): void;

Calls GetTransferRun.

Parameters
Name	Description
request	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
void

getTransferRun(request)

public getTransferRun(request: google.cloud.bigquery.datatransfer.v1.IGetTransferRunRequest): Promise<google.cloud.bigquery.datatransfer.v1.TransferRun>;

Calls GetTransferRun.

Parameter
Name	Description
request	IGetTransferRunRequest GetTransferRunRequest message or plain object

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

listDataSources(request, callback)

public listDataSources(request: google.cloud.bigquery.datatransfer.v1.IListDataSourcesRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ListDataSourcesCallback): void;

Calls ListDataSources.

Parameters
Name	Description
request	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
void

listDataSources(request)

public listDataSources(request: google.cloud.bigquery.datatransfer.v1.IListDataSourcesRequest): Promise<google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse>;

Calls ListDataSources.

Parameter
Name	Description
request	IListDataSourcesRequest ListDataSourcesRequest message or plain object

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

listTransferConfigs(request, callback)

public listTransferConfigs(request: google.cloud.bigquery.datatransfer.v1.IListTransferConfigsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferConfigsCallback): void;

Calls ListTransferConfigs.

Parameters
Name	Description
request	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
void

listTransferConfigs(request)

public listTransferConfigs(request: google.cloud.bigquery.datatransfer.v1.IListTransferConfigsRequest): Promise<google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse>;

Calls ListTransferConfigs.

Parameter
Name	Description
request	IListTransferConfigsRequest ListTransferConfigsRequest message or plain object

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

listTransferLogs(request, callback)

public listTransferLogs(request: google.cloud.bigquery.datatransfer.v1.IListTransferLogsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferLogsCallback): void;

Calls ListTransferLogs.

Parameters
Name	Description
request	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
void

listTransferLogs(request)

public listTransferLogs(request: google.cloud.bigquery.datatransfer.v1.IListTransferLogsRequest): Promise<google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse>;

Calls ListTransferLogs.

Parameter
Name	Description
request	IListTransferLogsRequest ListTransferLogsRequest message or plain object

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

listTransferRuns(request, callback)

public listTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IListTransferRunsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ListTransferRunsCallback): void;

Calls ListTransferRuns.

Parameters
Name	Description
request	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
void

listTransferRuns(request)

public listTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IListTransferRunsRequest): Promise<google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse>;

Calls ListTransferRuns.

Parameter
Name	Description
request	IListTransferRunsRequest ListTransferRunsRequest message or plain object

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

scheduleTransferRuns(request, callback)

public scheduleTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IScheduleTransferRunsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.ScheduleTransferRunsCallback): void;

Calls ScheduleTransferRuns.

Parameters
Name	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
void

scheduleTransferRuns(request)

public scheduleTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IScheduleTransferRunsRequest): Promise<google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse>;

Calls ScheduleTransferRuns.

Parameter
Name	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)

public startManualTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IStartManualTransferRunsRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.StartManualTransferRunsCallback): void;

Calls StartManualTransferRuns.

Parameters
Name	Description
request	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
void

startManualTransferRuns(request)

public startManualTransferRuns(request: google.cloud.bigquery.datatransfer.v1.IStartManualTransferRunsRequest): Promise<google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse>;

Calls StartManualTransferRuns.

Parameter
Name	Description
request	IStartManualTransferRunsRequest StartManualTransferRunsRequest message or plain object

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

updateTransferConfig(request, callback)

public updateTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IUpdateTransferConfigRequest, callback: google.cloud.bigquery.datatransfer.v1.DataTransferService.UpdateTransferConfigCallback): void;

Calls UpdateTransferConfig.

Parameters
Name	Description
request	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
void

updateTransferConfig(request)

public updateTransferConfig(request: google.cloud.bigquery.datatransfer.v1.IUpdateTransferConfigRequest): Promise<google.cloud.bigquery.datatransfer.v1.TransferConfig>;

Calls UpdateTransferConfig.

Parameter
Name	Description
request	IUpdateTransferConfigRequest UpdateTransferConfigRequest message or plain object

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