Interface DataTransferServiceGrpc.AsyncService
-
- All Known Implementing Classes:
DataTransferServiceGrpc.DataTransferServiceImplBase
- Enclosing class:
- DataTransferServiceGrpc
public static interface DataTransferServiceGrpc.AsyncService
This API allows users to manage their data transfers into BigQuery.
-
-
Method Summary
All Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description default void
checkValidCreds(CheckValidCredsRequest request, io.grpc.stub.StreamObserver<CheckValidCredsResponse> responseObserver)
Returns true if valid credentials exist for the given data source and requesting user.default void
createTransferConfig(CreateTransferConfigRequest request, io.grpc.stub.StreamObserver<TransferConfig> responseObserver)
Creates a new data transfer configuration.default void
deleteTransferConfig(DeleteTransferConfigRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes a data transfer configuration, including any associated transfer runs and logs.default void
deleteTransferRun(DeleteTransferRunRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes the specified transfer run.default void
enrollDataSources(EnrollDataSourcesRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Enroll data sources in a user project.default void
getDataSource(GetDataSourceRequest request, io.grpc.stub.StreamObserver<DataSource> responseObserver)
Retrieves a supported data source and returns its settings.default void
getTransferConfig(GetTransferConfigRequest request, io.grpc.stub.StreamObserver<TransferConfig> responseObserver)
Returns information about a data transfer config.default void
getTransferRun(GetTransferRunRequest request, io.grpc.stub.StreamObserver<TransferRun> responseObserver)
Returns information about the particular transfer run.default void
listDataSources(ListDataSourcesRequest request, io.grpc.stub.StreamObserver<ListDataSourcesResponse> responseObserver)
Lists supported data sources and returns their settings.default void
listTransferConfigs(ListTransferConfigsRequest request, io.grpc.stub.StreamObserver<ListTransferConfigsResponse> responseObserver)
Returns information about all transfer configs owned by a project in the specified location.default void
listTransferLogs(ListTransferLogsRequest request, io.grpc.stub.StreamObserver<ListTransferLogsResponse> responseObserver)
Returns log messages for the transfer run.default void
listTransferRuns(ListTransferRunsRequest request, io.grpc.stub.StreamObserver<ListTransferRunsResponse> responseObserver)
Returns information about running and completed transfer runs.default void
scheduleTransferRuns(ScheduleTransferRunsRequest request, io.grpc.stub.StreamObserver<ScheduleTransferRunsResponse> responseObserver)
Deprecated.default void
startManualTransferRuns(StartManualTransferRunsRequest request, io.grpc.stub.StreamObserver<StartManualTransferRunsResponse> responseObserver)
Start manual transfer runs to be executed now with schedule_time equal to current time.default void
updateTransferConfig(UpdateTransferConfigRequest request, io.grpc.stub.StreamObserver<TransferConfig> responseObserver)
Updates a data transfer configuration.
-
-
-
Method Detail
-
getDataSource
default void getDataSource(GetDataSourceRequest request, io.grpc.stub.StreamObserver<DataSource> responseObserver)
Retrieves a supported data source and returns its settings.
-
listDataSources
default void listDataSources(ListDataSourcesRequest request, io.grpc.stub.StreamObserver<ListDataSourcesResponse> responseObserver)
Lists supported data sources and returns their settings.
-
createTransferConfig
default void createTransferConfig(CreateTransferConfigRequest request, io.grpc.stub.StreamObserver<TransferConfig> responseObserver)
Creates a new data transfer configuration.
-
updateTransferConfig
default void updateTransferConfig(UpdateTransferConfigRequest request, io.grpc.stub.StreamObserver<TransferConfig> responseObserver)
Updates a data transfer configuration. All fields must be set, even if they are not updated.
-
deleteTransferConfig
default void deleteTransferConfig(DeleteTransferConfigRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes a data transfer configuration, including any associated transfer runs and logs.
-
getTransferConfig
default void getTransferConfig(GetTransferConfigRequest request, io.grpc.stub.StreamObserver<TransferConfig> responseObserver)
Returns information about a data transfer config.
-
listTransferConfigs
default void listTransferConfigs(ListTransferConfigsRequest request, io.grpc.stub.StreamObserver<ListTransferConfigsResponse> responseObserver)
Returns information about all transfer configs owned by a project in the specified location.
-
scheduleTransferRuns
@Deprecated default void scheduleTransferRuns(ScheduleTransferRunsRequest request, io.grpc.stub.StreamObserver<ScheduleTransferRunsResponse> responseObserver)
Deprecated.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.
-
startManualTransferRuns
default void startManualTransferRuns(StartManualTransferRunsRequest request, io.grpc.stub.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.
-
getTransferRun
default void getTransferRun(GetTransferRunRequest request, io.grpc.stub.StreamObserver<TransferRun> responseObserver)
Returns information about the particular transfer run.
-
deleteTransferRun
default void deleteTransferRun(DeleteTransferRunRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
Deletes the specified transfer run.
-
listTransferRuns
default void listTransferRuns(ListTransferRunsRequest request, io.grpc.stub.StreamObserver<ListTransferRunsResponse> responseObserver)
Returns information about running and completed transfer runs.
-
listTransferLogs
default void listTransferLogs(ListTransferLogsRequest request, io.grpc.stub.StreamObserver<ListTransferLogsResponse> responseObserver)
Returns log messages for the transfer run.
-
checkValidCreds
default void checkValidCreds(CheckValidCredsRequest request, io.grpc.stub.StreamObserver<CheckValidCredsResponse> responseObserver)
Returns true if valid credentials exist for the given data source and requesting user.
-
enrollDataSources
default void enrollDataSources(EnrollDataSourcesRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.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](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers).
-
-