com.google.cloud.bigquery.datatransfer.v1

Class DataTransferServiceGrpc.DataTransferServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<DataTransferServiceGrpc.DataTransferServiceBlockingStub>

com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceGrpc.DataTransferServiceBlockingStub

Enclosing class:

DataTransferServiceGrpc

public static final class DataTransferServiceGrpc.DataTransferServiceBlockingStub
extends io.grpc.stub.AbstractStub<DataTransferServiceGrpc.DataTransferServiceBlockingStub>

 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.
 

Method Summary

Modifier and Type	Method and Description
protected DataTransferServiceGrpc.DataTransferServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
CheckValidCredsResponse	checkValidCreds(CheckValidCredsRequest request) Returns true if valid credentials exist for the given data source and requesting user.
TransferConfig	createTransferConfig(CreateTransferConfigRequest request) Creates a new data transfer configuration.
Empty	deleteTransferConfig(DeleteTransferConfigRequest request) Deletes a data transfer configuration, including any associated transfer runs and logs.
Empty	deleteTransferRun(DeleteTransferRunRequest request) Deletes the specified transfer run.
DataSource	getDataSource(GetDataSourceRequest request) Retrieves a supported data source and returns its settings, which can be used for UI rendering.
TransferConfig	getTransferConfig(GetTransferConfigRequest request) Returns information about a data transfer config.
TransferRun	getTransferRun(GetTransferRunRequest request) Returns information about the particular transfer run.
ListDataSourcesResponse	listDataSources(ListDataSourcesRequest request) Lists supported data sources and returns their settings, which can be used for UI rendering.
ListTransferConfigsResponse	listTransferConfigs(ListTransferConfigsRequest request) Returns information about all data transfers in the project.
ListTransferLogsResponse	listTransferLogs(ListTransferLogsRequest request) Returns user facing log messages for the data transfer run.
ListTransferRunsResponse	listTransferRuns(ListTransferRunsRequest request) Returns information about running and completed jobs.
ScheduleTransferRunsResponse	scheduleTransferRuns(ScheduleTransferRunsRequest request) Creates transfer runs for a time range [start_time, end_time].
TransferConfig	updateTransferConfig(UpdateTransferConfigRequest request) Updates a data transfer configuration.

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected DataTransferServiceGrpc.DataTransferServiceBlockingStub build(io.grpc.Channel channel,
                                                                        io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<DataTransferServiceGrpc.DataTransferServiceBlockingStub>

getDataSource

public DataSource getDataSource(GetDataSourceRequest request)

 Retrieves a supported data source and returns its settings,
 which can be used for UI rendering.
 

listDataSources

public ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)

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

createTransferConfig

public TransferConfig createTransferConfig(CreateTransferConfigRequest request)

 Creates a new data transfer configuration.
 

updateTransferConfig

public TransferConfig updateTransferConfig(UpdateTransferConfigRequest request)

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

deleteTransferConfig

public Empty deleteTransferConfig(DeleteTransferConfigRequest request)

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

getTransferConfig

public TransferConfig getTransferConfig(GetTransferConfigRequest request)

 Returns information about a data transfer config.
 

listTransferConfigs

public ListTransferConfigsResponse listTransferConfigs(ListTransferConfigsRequest request)

 Returns information about all data transfers in the project.
 

scheduleTransferRuns

public 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.
 

getTransferRun

public TransferRun getTransferRun(GetTransferRunRequest request)

 Returns information about the particular transfer run.
 

deleteTransferRun

public Empty deleteTransferRun(DeleteTransferRunRequest request)

 Deletes the specified transfer run.
 

listTransferRuns

public ListTransferRunsResponse listTransferRuns(ListTransferRunsRequest request)

 Returns information about running and completed jobs.
 

listTransferLogs

public ListTransferLogsResponse listTransferLogs(ListTransferLogsRequest request)

 Returns user facing log messages for the data transfer run.
 

checkValidCreds

public 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.