Class DataTransferServiceGrpc.DataTransferServiceStub (2.20.0)

public static final class DataTransferServiceGrpc.DataTransferServiceStub extends AbstractAsyncStub<DataTransferServiceGrpc.DataTransferServiceStub>

A stub to allow clients to do asynchronous rpc calls to service DataTransferService.

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > DataTransferServiceGrpc.DataTransferServiceStub

Methods

build(Channel channel, CallOptions callOptions)

protected DataTransferServiceGrpc.DataTransferServiceStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DataTransferServiceGrpc.DataTransferServiceStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

checkValidCreds(CheckValidCredsRequest request, StreamObserver<CheckValidCredsResponse> responseObserver)

public void checkValidCreds(CheckValidCredsRequest request, StreamObserver<CheckValidCredsResponse> responseObserver)

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

Parameters
NameDescription
requestCheckValidCredsRequest
responseObserverio.grpc.stub.StreamObserver<CheckValidCredsResponse>

createTransferConfig(CreateTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

public void createTransferConfig(CreateTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

Creates a new data transfer configuration.

Parameters
NameDescription
requestCreateTransferConfigRequest
responseObserverio.grpc.stub.StreamObserver<TransferConfig>

deleteTransferConfig(DeleteTransferConfigRequest request, StreamObserver<Empty> responseObserver)

public void deleteTransferConfig(DeleteTransferConfigRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
NameDescription
requestDeleteTransferConfigRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

deleteTransferRun(DeleteTransferRunRequest request, StreamObserver<Empty> responseObserver)

public void deleteTransferRun(DeleteTransferRunRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified transfer run.

Parameters
NameDescription
requestDeleteTransferRunRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

enrollDataSources(EnrollDataSourcesRequest request, StreamObserver<Empty> responseObserver)

public 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
NameDescription
requestEnrollDataSourcesRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

getDataSource(GetDataSourceRequest request, StreamObserver<DataSource> responseObserver)

public void getDataSource(GetDataSourceRequest request, StreamObserver<DataSource> responseObserver)

Retrieves a supported data source and returns its settings.

Parameters
NameDescription
requestGetDataSourceRequest
responseObserverio.grpc.stub.StreamObserver<DataSource>

getTransferConfig(GetTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

public void getTransferConfig(GetTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

Returns information about a data transfer config.

Parameters
NameDescription
requestGetTransferConfigRequest
responseObserverio.grpc.stub.StreamObserver<TransferConfig>

getTransferRun(GetTransferRunRequest request, StreamObserver<TransferRun> responseObserver)

public void getTransferRun(GetTransferRunRequest request, StreamObserver<TransferRun> responseObserver)

Returns information about the particular transfer run.

Parameters
NameDescription
requestGetTransferRunRequest
responseObserverio.grpc.stub.StreamObserver<TransferRun>

listDataSources(ListDataSourcesRequest request, StreamObserver<ListDataSourcesResponse> responseObserver)

public void listDataSources(ListDataSourcesRequest request, StreamObserver<ListDataSourcesResponse> responseObserver)

Lists supported data sources and returns their settings.

Parameters
NameDescription
requestListDataSourcesRequest
responseObserverio.grpc.stub.StreamObserver<ListDataSourcesResponse>

listTransferConfigs(ListTransferConfigsRequest request, StreamObserver<ListTransferConfigsResponse> responseObserver)

public void listTransferConfigs(ListTransferConfigsRequest request, StreamObserver<ListTransferConfigsResponse> responseObserver)

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

Parameters
NameDescription
requestListTransferConfigsRequest
responseObserverio.grpc.stub.StreamObserver<ListTransferConfigsResponse>

listTransferLogs(ListTransferLogsRequest request, StreamObserver<ListTransferLogsResponse> responseObserver)

public void listTransferLogs(ListTransferLogsRequest request, StreamObserver<ListTransferLogsResponse> responseObserver)

Returns log messages for the transfer run.

Parameters
NameDescription
requestListTransferLogsRequest
responseObserverio.grpc.stub.StreamObserver<ListTransferLogsResponse>

listTransferRuns(ListTransferRunsRequest request, StreamObserver<ListTransferRunsResponse> responseObserver)

public void listTransferRuns(ListTransferRunsRequest request, StreamObserver<ListTransferRunsResponse> responseObserver)

Returns information about running and completed transfer runs.

Parameters
NameDescription
requestListTransferRunsRequest
responseObserverio.grpc.stub.StreamObserver<ListTransferRunsResponse>

scheduleTransferRuns(ScheduleTransferRunsRequest request, StreamObserver<ScheduleTransferRunsResponse> responseObserver)

public 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
NameDescription
requestScheduleTransferRunsRequest
responseObserverio.grpc.stub.StreamObserver<ScheduleTransferRunsResponse>

startManualTransferRuns(StartManualTransferRunsRequest request, StreamObserver<StartManualTransferRunsResponse> responseObserver)

public 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
NameDescription
requestStartManualTransferRunsRequest
responseObserverio.grpc.stub.StreamObserver<StartManualTransferRunsResponse>

updateTransferConfig(UpdateTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

public void updateTransferConfig(UpdateTransferConfigRequest request, StreamObserver<TransferConfig> responseObserver)

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

Parameters
NameDescription
requestUpdateTransferConfigRequest
responseObserverio.grpc.stub.StreamObserver<TransferConfig>