Class DataTransferServiceGrpc.DataTransferServiceFutureStub (2.0.27)

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

The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. This service contains methods that are end user exposed. It backs up the frontend.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DataTransferServiceGrpc.DataTransferServiceFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected DataTransferServiceGrpc.DataTransferServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters

Name	Description
channel	`io.grpc.Channel`
callOptions	`io.grpc.CallOptions`

Returns

Type	Description
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. Some data sources doesn't support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Parameter

Name	Description
request	`CheckValidCredsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<CheckValidCredsResponse>

createTransferConfig(CreateTransferConfigRequest request)

public ListenableFuture<TransferConfig> createTransferConfig(CreateTransferConfigRequest request)

Creates a new data transfer configuration.

Parameter

Name	Description
request	`CreateTransferConfigRequest`

Returns

Type	Description
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

Name	Description
request	`DeleteTransferConfigRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteTransferRun(DeleteTransferRunRequest request)

public ListenableFuture<Empty> deleteTransferRun(DeleteTransferRunRequest request)

Deletes the specified transfer run.

Parameter

Name	Description
request	`DeleteTransferRunRequest`

Returns

Type	Description
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, which can be used for UI rendering.

Parameter

Name	Description
request	`GetDataSourceRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<DataSource>

getTransferConfig(GetTransferConfigRequest request)

public ListenableFuture<TransferConfig> getTransferConfig(GetTransferConfigRequest request)

Returns information about a data transfer config.

Parameter

Name	Description
request	`GetTransferConfigRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<TransferConfig>

getTransferRun(GetTransferRunRequest request)

public ListenableFuture<TransferRun> getTransferRun(GetTransferRunRequest request)

Returns information about the particular transfer run.

Parameter

Name	Description
request	`GetTransferRunRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<TransferRun>

listDataSources(ListDataSourcesRequest request)

public ListenableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest request)

Lists supported data sources and returns their settings, which can be used for UI rendering.

Parameter

Name	Description
request	`ListDataSourcesRequest`

Returns

Type	Description
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

Name	Description
request	`ListTransferConfigsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListTransferConfigsResponse>

listTransferLogs(ListTransferLogsRequest request)

public ListenableFuture<ListTransferLogsResponse> listTransferLogs(ListTransferLogsRequest request)

Returns user facing log messages for the data transfer run.

Parameter

Name	Description
request	`ListTransferLogsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListTransferLogsResponse>

listTransferRuns(ListTransferRunsRequest request)

public ListenableFuture<ListTransferRunsResponse> listTransferRuns(ListTransferRunsRequest request)

Returns information about running and completed jobs.

Parameter

Name	Description
request	`ListTransferRunsRequest`

Returns

Type	Description
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

Name	Description
request	`ScheduleTransferRunsRequest`

Returns

Type	Description
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

Name	Description
request	`StartManualTransferRunsRequest`

Returns

Type	Description
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

Name	Description
request	`UpdateTransferConfigRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<TransferConfig>