Class DataTransferServiceGrpc.DataTransferServiceBlockingStub

public static final class DataTransferServiceGrpc.DataTransferServiceBlockingStub extends AbstractBlockingStub<DataTransferServiceGrpc.DataTransferServiceBlockingStub>

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

Methods

build(Channel channel, CallOptions callOptions)

protected DataTransferServiceGrpc.DataTransferServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
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
NameDescription
requestCheckValidCredsRequest
Returns
TypeDescription
CheckValidCredsResponse

createTransferConfig(CreateTransferConfigRequest request)

public TransferConfig createTransferConfig(CreateTransferConfigRequest request)

Creates a new data transfer configuration.

Parameter
NameDescription
requestCreateTransferConfigRequest
Returns
TypeDescription
TransferConfig

deleteTransferConfig(DeleteTransferConfigRequest request)

public Empty deleteTransferConfig(DeleteTransferConfigRequest request)

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

Parameter
NameDescription
requestDeleteTransferConfigRequest
Returns
TypeDescription
Empty

deleteTransferRun(DeleteTransferRunRequest request)

public Empty deleteTransferRun(DeleteTransferRunRequest request)

Deletes the specified transfer run.

Parameter
NameDescription
requestDeleteTransferRunRequest
Returns
TypeDescription
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 'https://bigquery.cloud.google.com' (and the documents can be found at https://cloud.google.com/bigquery/bigquery-web-ui and https://cloud.google.com/bigquery/docs/working-with-transfers).

Parameter
NameDescription
requestEnrollDataSourcesRequest
Returns
TypeDescription
Empty

getDataSource(GetDataSourceRequest request)

public DataSource getDataSource(GetDataSourceRequest request)

Retrieves a supported data source and returns its settings.

Parameter
NameDescription
requestGetDataSourceRequest
Returns
TypeDescription
DataSource

getTransferConfig(GetTransferConfigRequest request)

public TransferConfig getTransferConfig(GetTransferConfigRequest request)

Returns information about a data transfer config.

Parameter
NameDescription
requestGetTransferConfigRequest
Returns
TypeDescription
TransferConfig

getTransferRun(GetTransferRunRequest request)

public TransferRun getTransferRun(GetTransferRunRequest request)

Returns information about the particular transfer run.

Parameter
NameDescription
requestGetTransferRunRequest
Returns
TypeDescription
TransferRun

listDataSources(ListDataSourcesRequest request)

public ListDataSourcesResponse listDataSources(ListDataSourcesRequest request)

Lists supported data sources and returns their settings.

Parameter
NameDescription
requestListDataSourcesRequest
Returns
TypeDescription
ListDataSourcesResponse

listTransferConfigs(ListTransferConfigsRequest request)

public ListTransferConfigsResponse listTransferConfigs(ListTransferConfigsRequest request)

Returns information about all transfer configs owned by a project in the specified location.

Parameter
NameDescription
requestListTransferConfigsRequest
Returns
TypeDescription
ListTransferConfigsResponse

listTransferLogs(ListTransferLogsRequest request)

public ListTransferLogsResponse listTransferLogs(ListTransferLogsRequest request)

Returns log messages for the transfer run.

Parameter
NameDescription
requestListTransferLogsRequest
Returns
TypeDescription
ListTransferLogsResponse

listTransferRuns(ListTransferRunsRequest request)

public ListTransferRunsResponse listTransferRuns(ListTransferRunsRequest request)

Returns information about running and completed transfer runs.

Parameter
NameDescription
requestListTransferRunsRequest
Returns
TypeDescription
ListTransferRunsResponse

scheduleTransferRuns(ScheduleTransferRunsRequest request)

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
NameDescription
requestScheduleTransferRunsRequest
Returns
TypeDescription
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
NameDescription
requestStartManualTransferRunsRequest
Returns
TypeDescription
StartManualTransferRunsResponse

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
NameDescription
requestUpdateTransferConfigRequest
Returns
TypeDescription
TransferConfig