Class DataTransferServiceGrpc.DataTransferServiceFutureStub (2.27.0)

public static final class DataTransferServiceGrpc.DataTransferServiceFutureStub extends AbstractFutureStub<DataTransferServiceGrpc.DataTransferServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > DataTransferServiceGrpc.DataTransferServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

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

checkValidCreds(CheckValidCredsRequest request)

public ListenableFuture<CheckValidCredsResponse> checkValidCreds(CheckValidCredsRequest request)

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

Parameter
NameDescription
requestCheckValidCredsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CheckValidCredsResponse>

createTransferConfig(CreateTransferConfigRequest request)

public ListenableFuture<TransferConfig> createTransferConfig(CreateTransferConfigRequest request)

Creates a new data transfer configuration.

Parameter
NameDescription
requestCreateTransferConfigRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TransferConfig>

deleteTransferConfig(DeleteTransferConfigRequest request)

public ListenableFuture<Empty> deleteTransferConfig(DeleteTransferConfigRequest request)

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

Parameter
NameDescription
requestDeleteTransferConfigRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteTransferRun(DeleteTransferRunRequest request)

public ListenableFuture<Empty> deleteTransferRun(DeleteTransferRunRequest request)

Deletes the specified transfer run.

Parameter
NameDescription
requestDeleteTransferRunRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

enrollDataSources(EnrollDataSourcesRequest request)

public ListenableFuture<Empty> enrollDataSources(EnrollDataSourcesRequest request)

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.

Parameter
NameDescription
requestEnrollDataSourcesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

getDataSource(GetDataSourceRequest request)

public ListenableFuture<DataSource> getDataSource(GetDataSourceRequest request)

Retrieves a supported data source and returns its settings.

Parameter
NameDescription
requestGetDataSourceRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<DataSource>

getTransferConfig(GetTransferConfigRequest request)

public ListenableFuture<TransferConfig> getTransferConfig(GetTransferConfigRequest request)

Returns information about a data transfer config.

Parameter
NameDescription
requestGetTransferConfigRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TransferConfig>

getTransferRun(GetTransferRunRequest request)

public ListenableFuture<TransferRun> getTransferRun(GetTransferRunRequest request)

Returns information about the particular transfer run.

Parameter
NameDescription
requestGetTransferRunRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TransferRun>

listDataSources(ListDataSourcesRequest request)

public ListenableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest request)

Lists supported data sources and returns their settings.

Parameter
NameDescription
requestListDataSourcesRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListDataSourcesResponse>

listTransferConfigs(ListTransferConfigsRequest request)

public ListenableFuture<ListTransferConfigsResponse> listTransferConfigs(ListTransferConfigsRequest request)

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

Parameter
NameDescription
requestListTransferConfigsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListTransferConfigsResponse>

listTransferLogs(ListTransferLogsRequest request)

public ListenableFuture<ListTransferLogsResponse> listTransferLogs(ListTransferLogsRequest request)

Returns log messages for the transfer run.

Parameter
NameDescription
requestListTransferLogsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListTransferLogsResponse>

listTransferRuns(ListTransferRunsRequest request)

public ListenableFuture<ListTransferRunsResponse> listTransferRuns(ListTransferRunsRequest request)

Returns information about running and completed transfer runs.

Parameter
NameDescription
requestListTransferRunsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListTransferRunsResponse>

scheduleTransferRuns(ScheduleTransferRunsRequest request)

public ListenableFuture<ScheduleTransferRunsResponse> scheduleTransferRuns(ScheduleTransferRunsRequest request)

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.

Parameter
NameDescription
requestScheduleTransferRunsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ScheduleTransferRunsResponse>

startManualTransferRuns(StartManualTransferRunsRequest request)

public ListenableFuture<StartManualTransferRunsResponse> startManualTransferRuns(StartManualTransferRunsRequest request)

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.

Parameter
NameDescription
requestStartManualTransferRunsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<StartManualTransferRunsResponse>

updateTransferConfig(UpdateTransferConfigRequest request)

public ListenableFuture<TransferConfig> updateTransferConfig(UpdateTransferConfigRequest request)

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

Parameter
NameDescription
requestUpdateTransferConfigRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<TransferConfig>