Interface DataTransferServiceGrpc.AsyncService (2.75.0) 

publicstaticinterface DataTransferServiceGrpc.AsyncService

This API allows users to manage their data transfers into BigQuery.

Methods

checkValidCreds(CheckValidCredsRequest request, StreamObserver<CheckValidCredsResponse> responseObserver)

publicdefaultvoidcheckValidCreds(CheckValidCredsRequestrequest,StreamObserver<CheckValidCredsResponse>responseObserver)

Returns true if valid credentials exist for the given data source and requesting user.

Parameters
Name Description
request CheckValidCredsRequest
responseObserver io.grpc.stub.StreamObserver<CheckValidCredsResponse>

createTransferConfig(CreateTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

publicdefaultvoidcreateTransferConfig(CreateTransferConfigRequestrequest,StreamObserver<TransferConfig>responseObserver)

Creates a new data transfer configuration.

Parameters
Name Description
request CreateTransferConfigRequest
responseObserver io.grpc.stub.StreamObserver<TransferConfig>

deleteTransferConfig(DeleteTransferConfigRequest request, StreamObserver<Empty> responseObserver)

publicdefaultvoiddeleteTransferConfig(DeleteTransferConfigRequestrequest,StreamObserver<Empty>responseObserver)

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

Parameters
Name Description
request DeleteTransferConfigRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteTransferRun(DeleteTransferRunRequest request, StreamObserver<Empty> responseObserver)

publicdefaultvoiddeleteTransferRun(DeleteTransferRunRequestrequest,StreamObserver<Empty>responseObserver)

Deletes the specified transfer run.

Parameters
Name Description
request DeleteTransferRunRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

enrollDataSources(EnrollDataSourcesRequest request, StreamObserver<Empty> responseObserver)

publicdefaultvoidenrollDataSources(EnrollDataSourcesRequestrequest,StreamObserver<Empty>responseObserver)

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.

Parameters
Name Description
request EnrollDataSourcesRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getDataSource(GetDataSourceRequest request, StreamObserver<DataSource> responseObserver)

publicdefaultvoidgetDataSource(GetDataSourceRequestrequest,StreamObserver<DataSource>responseObserver)

Retrieves a supported data source and returns its settings.

Parameters
Name Description
request GetDataSourceRequest
responseObserver io.grpc.stub.StreamObserver<DataSource>

getTransferConfig(GetTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

publicdefaultvoidgetTransferConfig(GetTransferConfigRequestrequest,StreamObserver<TransferConfig>responseObserver)

Returns information about a data transfer config.

Parameters
Name Description
request GetTransferConfigRequest
responseObserver io.grpc.stub.StreamObserver<TransferConfig>

getTransferRun(GetTransferRunRequest request, StreamObserver<TransferRun> responseObserver)

publicdefaultvoidgetTransferRun(GetTransferRunRequestrequest,StreamObserver<TransferRun>responseObserver)

Returns information about the particular transfer run.

Parameters
Name Description
request GetTransferRunRequest
responseObserver io.grpc.stub.StreamObserver<TransferRun>

listDataSources(ListDataSourcesRequest request, StreamObserver<ListDataSourcesResponse> responseObserver)

publicdefaultvoidlistDataSources(ListDataSourcesRequestrequest,StreamObserver<ListDataSourcesResponse>responseObserver)

Lists supported data sources and returns their settings.

Parameters
Name Description
request ListDataSourcesRequest
responseObserver io.grpc.stub.StreamObserver<ListDataSourcesResponse>

listTransferConfigs(ListTransferConfigsRequest request, StreamObserver<ListTransferConfigsResponse> responseObserver)

publicdefaultvoidlistTransferConfigs(ListTransferConfigsRequestrequest,StreamObserver<ListTransferConfigsResponse>responseObserver)

Returns information about all transfer configs owned by a project in the specified location.

Parameters
Name Description
request ListTransferConfigsRequest
responseObserver io.grpc.stub.StreamObserver<ListTransferConfigsResponse>

listTransferLogs(ListTransferLogsRequest request, StreamObserver<ListTransferLogsResponse> responseObserver)

publicdefaultvoidlistTransferLogs(ListTransferLogsRequestrequest,StreamObserver<ListTransferLogsResponse>responseObserver)

Returns log messages for the transfer run.

Parameters
Name Description
request ListTransferLogsRequest
responseObserver io.grpc.stub.StreamObserver<ListTransferLogsResponse>

listTransferRuns(ListTransferRunsRequest request, StreamObserver<ListTransferRunsResponse> responseObserver)

publicdefaultvoidlistTransferRuns(ListTransferRunsRequestrequest,StreamObserver<ListTransferRunsResponse>responseObserver)

Returns information about running and completed transfer runs.

Parameters
Name Description
request ListTransferRunsRequest
responseObserver io.grpc.stub.StreamObserver<ListTransferRunsResponse>

scheduleTransferRuns(ScheduleTransferRunsRequest request, StreamObserver<ScheduleTransferRunsResponse> responseObserver) (deprecated)

publicdefaultvoidscheduleTransferRuns(ScheduleTransferRunsRequestrequest,StreamObserver<ScheduleTransferRunsResponse>responseObserver)

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 Description
request ScheduleTransferRunsRequest
responseObserver io.grpc.stub.StreamObserver<ScheduleTransferRunsResponse>

startManualTransferRuns(StartManualTransferRunsRequest request, StreamObserver<StartManualTransferRunsResponse> responseObserver)

publicdefaultvoidstartManualTransferRuns(StartManualTransferRunsRequestrequest,StreamObserver<StartManualTransferRunsResponse>responseObserver)

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 Description
request StartManualTransferRunsRequest
responseObserver io.grpc.stub.StreamObserver<StartManualTransferRunsResponse>

unenrollDataSources(UnenrollDataSourcesRequest request, StreamObserver<Empty> responseObserver)

publicdefaultvoidunenrollDataSources(UnenrollDataSourcesRequestrequest,StreamObserver<Empty>responseObserver)

Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI. Data transfers configurations of unenrolled data sources will not be scheduled.

Parameters
Name Description
request UnenrollDataSourcesRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

updateTransferConfig(UpdateTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

publicdefaultvoidupdateTransferConfig(UpdateTransferConfigRequestrequest,StreamObserver<TransferConfig>responseObserver)

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

Parameters
Name Description
request UpdateTransferConfigRequest
responseObserver io.grpc.stub.StreamObserver<TransferConfig>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.