public static final class DataTransferServiceGrpc.DataTransferServiceBlockingStub extends 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.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractBlockingStub >
DataTransferServiceGrpc.DataTransferServiceBlockingStub
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<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.withOnReadyThreshold(int)
io.grpc.stub.AbstractStub.withWaitForReady()
Methods
build(Channel channel, CallOptions callOptions)
protected DataTransferServiceGrpc.DataTransferServiceBlockingStub build(Channel channel, CallOptions callOptions)
| Parameters |
| Name |
Description |
channel |
io.grpc.Channel
|
callOptions |
io.grpc.CallOptions
|
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
checkValidCreds(CheckValidCredsRequest request)
public CheckValidCredsResponse checkValidCreds(CheckValidCredsRequest request)
Returns true if valid credentials exist for the given data source and
requesting user.
createTransferConfig(CreateTransferConfigRequest request)
public TransferConfig createTransferConfig(CreateTransferConfigRequest request)
Creates a new data transfer configuration.
deleteTransferConfig(DeleteTransferConfigRequest request)
public Empty deleteTransferConfig(DeleteTransferConfigRequest request)
Deletes a data transfer configuration, including any associated transfer
runs and logs.
| Returns |
| Type |
Description |
Empty |
|
deleteTransferRun(DeleteTransferRunRequest request)
public Empty deleteTransferRun(DeleteTransferRunRequest request)
Deletes the specified transfer run.
| Returns |
| Type |
Description |
Empty |
|
enrollDataSources(EnrollDataSourcesRequest request)
public 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.
| Returns |
| Type |
Description |
Empty |
|
getDataSource(GetDataSourceRequest request)
public DataSource getDataSource(GetDataSourceRequest request)
Retrieves a supported data source and returns its settings.
getTransferConfig(GetTransferConfigRequest request)
public TransferConfig getTransferConfig(GetTransferConfigRequest request)
Returns information about a data transfer config.
getTransferRun(GetTransferRunRequest request)
public TransferRun getTransferRun(GetTransferRunRequest request)
Returns information about the particular transfer run.
listDataSources(ListDataSourcesRequest request)
public ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)
Lists supported data sources and returns their settings.
listTransferConfigs(ListTransferConfigsRequest request)
public ListTransferConfigsResponse listTransferConfigs(ListTransferConfigsRequest request)
Returns information about all transfer configs owned by a project in the
specified location.
listTransferLogs(ListTransferLogsRequest request)
public ListTransferLogsResponse listTransferLogs(ListTransferLogsRequest request)
Returns log messages for the transfer run.
listTransferRuns(ListTransferRunsRequest request)
public ListTransferRunsResponse listTransferRuns(ListTransferRunsRequest request)
Returns information about running and completed transfer runs.
scheduleTransferRuns(ScheduleTransferRunsRequest request) (deprecated)
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.
DEPRECATED: use StartManualTransferRuns instead.
startManualTransferRuns(StartManualTransferRunsRequest request)
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.
unenrollDataSources(UnenrollDataSourcesRequest request)
public Empty unenrollDataSources(UnenrollDataSourcesRequest request)
Unenroll data sources in a user project. This allows users to remove
transfer configurations for these data sources. They will no longer appear
in the ListDataSources RPC and will also no longer appear in the BigQuery
UI. Data transfers
configurations of unenrolled data sources will not be scheduled.
| Returns |
| Type |
Description |
Empty |
|
updateTransferConfig(UpdateTransferConfigRequest request)
public TransferConfig updateTransferConfig(UpdateTransferConfigRequest request)
Updates a data transfer configuration.
All fields must be set, even if they are not updated.
