Package com.google.cloud.bigquery.datatransfer.v1

Class DataTransferServiceGrpc.DataTransferServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

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

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

Enclosing class:

DataTransferServiceGrpc

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

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

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

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method	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.
com.google.protobuf.Empty	deleteTransferConfig(DeleteTransferConfigRequest request)	Deletes a data transfer configuration, including any associated transfer runs and logs.
com.google.protobuf.Empty	deleteTransferRun(DeleteTransferRunRequest request)	Deletes the specified transfer run.
com.google.protobuf.Empty	enrollDataSources(EnrollDataSourcesRequest request)	Enroll data sources in a user project.
DataSource	getDataSource(GetDataSourceRequest request)	Retrieves a supported data source and returns its settings.
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.
ListTransferConfigsResponse	listTransferConfigs(ListTransferConfigsRequest request)	Returns information about all transfer configs owned by a project in the specified location.
ListTransferLogsResponse	listTransferLogs(ListTransferLogsRequest request)	Returns log messages for the transfer run.
ListTransferRunsResponse	listTransferRuns(ListTransferRunsRequest request)	Returns information about running and completed transfer runs.
ScheduleTransferRunsResponse	scheduleTransferRuns(ScheduleTransferRunsRequest request)	Deprecated.
StartManualTransferRunsResponse	startManualTransferRuns(StartManualTransferRunsRequest request)	Start manual transfer runs to be executed now with schedule_time equal to current time.
TransferConfig	updateTransferConfig(UpdateTransferConfigRequest request)	Updates a data transfer configuration.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

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.
 

listDataSources

public ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)

 Lists supported data sources and returns their settings.
 

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 com.google.protobuf.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 transfer configs owned by a project in the
 specified location.
 

scheduleTransferRuns

@Deprecated
public ScheduleTransferRunsResponse scheduleTransferRuns(ScheduleTransferRunsRequest request)

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

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

getTransferRun

public TransferRun getTransferRun(GetTransferRunRequest request)

 Returns information about the particular transfer run.
 

deleteTransferRun

public com.google.protobuf.Empty deleteTransferRun(DeleteTransferRunRequest request)

 Deletes the specified transfer run.
 

listTransferRuns

public ListTransferRunsResponse listTransferRuns(ListTransferRunsRequest request)

 Returns information about running and completed transfer runs.
 

listTransferLogs

public ListTransferLogsResponse listTransferLogs(ListTransferLogsRequest request)

 Returns log messages for the transfer run.
 

checkValidCreds

public CheckValidCredsResponse checkValidCreds(CheckValidCredsRequest request)

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

enrollDataSources

public com.google.protobuf.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](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).