Interface DataTransferServiceGrpc.AsyncService (2.31.0)

Version 2.31.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.17
• 2.2.6
• 2.1.23
• 2.0.27

public static interface DataTransferServiceGrpc.AsyncService

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

Methods

checkValidCreds(CheckValidCredsRequest request, StreamObserver<CheckValidCredsResponse> responseObserver)

public default void checkValidCreds(CheckValidCredsRequest request, 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)

public default void createTransferConfig(CreateTransferConfigRequest request, 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)

public default void deleteTransferConfig(DeleteTransferConfigRequest request, 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)

public default void deleteTransferRun(DeleteTransferRunRequest request, 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)

public default void enrollDataSources(EnrollDataSourcesRequest request, 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)

public default void getDataSource(GetDataSourceRequest request, 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)

public default void getTransferConfig(GetTransferConfigRequest request, 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)

public default void getTransferRun(GetTransferRunRequest request, 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)

public default void listDataSources(ListDataSourcesRequest request, 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)

public default void listTransferConfigs(ListTransferConfigsRequest request, 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)

public default void listTransferLogs(ListTransferLogsRequest request, 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)

public default void listTransferRuns(ListTransferRunsRequest request, 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)

public default void scheduleTransferRuns(ScheduleTransferRunsRequest request, 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)

public default void startManualTransferRuns(StartManualTransferRunsRequest request, 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>

updateTransferConfig(UpdateTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

public default void updateTransferConfig(UpdateTransferConfigRequest request, 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>