Class DataTransferServiceGrpc.DataTransferServiceBlockingStub (2.55.0)

Version latest

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.17
• 2.2.6
• 2.1.23
• 2.0.27

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(java.time.Duration)

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()

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.DataTransferServiceBlockingStub build(Channel channel, CallOptions callOptions)

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

Returns
Type	Description
DataTransferServiceGrpc.DataTransferServiceBlockingStub

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.

Parameter
Name	Description
request	CheckValidCredsRequest

Returns
Type	Description
CheckValidCredsResponse

createTransferConfig(CreateTransferConfigRequest request)

public TransferConfig createTransferConfig(CreateTransferConfigRequest request)

Creates a new data transfer configuration.

Parameter
Name	Description
request	CreateTransferConfigRequest

Returns
Type	Description
TransferConfig

deleteTransferConfig(DeleteTransferConfigRequest request)

public Empty deleteTransferConfig(DeleteTransferConfigRequest request)

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

Parameter
Name	Description
request	DeleteTransferConfigRequest

Returns
Type	Description
Empty

deleteTransferRun(DeleteTransferRunRequest request)

public Empty deleteTransferRun(DeleteTransferRunRequest request)

Deletes the specified transfer run.

Parameter
Name	Description
request	DeleteTransferRunRequest

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.

Parameter
Name	Description
request	EnrollDataSourcesRequest

Returns
Type	Description
Empty

getDataSource(GetDataSourceRequest request)

public DataSource getDataSource(GetDataSourceRequest request)

Retrieves a supported data source and returns its settings.

Parameter
Name	Description
request	GetDataSourceRequest

Returns
Type	Description
DataSource

getTransferConfig(GetTransferConfigRequest request)

public TransferConfig getTransferConfig(GetTransferConfigRequest request)

Returns information about a data transfer config.

Parameter
Name	Description
request	GetTransferConfigRequest

Returns
Type	Description
TransferConfig

getTransferRun(GetTransferRunRequest request)

public TransferRun getTransferRun(GetTransferRunRequest request)

Returns information about the particular transfer run.

Parameter
Name	Description
request	GetTransferRunRequest

Returns
Type	Description
TransferRun

listDataSources(ListDataSourcesRequest request)

public ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)

Lists supported data sources and returns their settings.

Parameter
Name	Description
request	ListDataSourcesRequest

Returns
Type	Description
ListDataSourcesResponse

listTransferConfigs(ListTransferConfigsRequest request)

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

listTransferLogs(ListTransferLogsRequest request)

public ListTransferLogsResponse listTransferLogs(ListTransferLogsRequest request)

Returns log messages for the transfer run.

Parameter
Name	Description
request	ListTransferLogsRequest

Returns
Type	Description
ListTransferLogsResponse

listTransferRuns(ListTransferRunsRequest request)

public ListTransferRunsResponse listTransferRuns(ListTransferRunsRequest request)

Returns information about running and completed transfer runs.

Parameter
Name	Description
request	ListTransferRunsRequest

Returns
Type	Description
ListTransferRunsResponse

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.

Parameter
Name	Description
request	ScheduleTransferRunsRequest

Returns
Type	Description
ScheduleTransferRunsResponse

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.

Parameter
Name	Description
request	StartManualTransferRunsRequest

Returns
Type	Description
StartManualTransferRunsResponse

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.

Parameter
Name	Description
request	UnenrollDataSourcesRequest

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.

Parameter
Name	Description
request	UpdateTransferConfigRequest

Returns
Type	Description
TransferConfig