Class DataTransferServiceClientImpl (3.1.0)

public sealed class DataTransferServiceClientImpl : DataTransferServiceClient

DataTransferService client wrapper implementation, for convenient use.

Inheritance

Object > DataTransferServiceClient > DataTransferServiceClientImpl

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Remarks

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.

Constructors

DataTransferServiceClientImpl(DataTransferService.DataTransferServiceClient, DataTransferServiceSettings)

public DataTransferServiceClientImpl(DataTransferService.DataTransferServiceClient grpcClient, DataTransferServiceSettings settings)

Constructs a client wrapper for the DataTransferService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientDataTransferService.DataTransferServiceClient

The underlying gRPC client.

settingsDataTransferServiceSettings

The base DataTransferServiceSettings used within this client.

Properties

GrpcClient

public override DataTransferService.DataTransferServiceClient GrpcClient { get; }

The underlying gRPC DataTransferService client

Property Value
TypeDescription
DataTransferService.DataTransferServiceClient
Overrides

Methods

CheckValidCreds(CheckValidCredsRequest, CallSettings)

public override CheckValidCredsResponse CheckValidCreds(CheckValidCredsRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestCheckValidCredsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
CheckValidCredsResponse

The RPC response.

Overrides

CheckValidCredsAsync(CheckValidCredsRequest, CallSettings)

public override Task<CheckValidCredsResponse> CheckValidCredsAsync(CheckValidCredsRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestCheckValidCredsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<CheckValidCredsResponse>

A Task containing the RPC response.

Overrides

CreateTransferConfig(CreateTransferConfigRequest, CallSettings)

public override TransferConfig CreateTransferConfig(CreateTransferConfigRequest request, CallSettings callSettings = null)

Creates a new data transfer configuration.

Parameters
NameDescription
requestCreateTransferConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Overrides

CreateTransferConfigAsync(CreateTransferConfigRequest, CallSettings)

public override Task<TransferConfig> CreateTransferConfigAsync(CreateTransferConfigRequest request, CallSettings callSettings = null)

Creates a new data transfer configuration.

Parameters
NameDescription
requestCreateTransferConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Overrides

DeleteTransferConfig(DeleteTransferConfigRequest, CallSettings)

public override void DeleteTransferConfig(DeleteTransferConfigRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestDeleteTransferConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteTransferConfigAsync(DeleteTransferConfigRequest, CallSettings)

public override Task DeleteTransferConfigAsync(DeleteTransferConfigRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestDeleteTransferConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteTransferRun(DeleteTransferRunRequest, CallSettings)

public override void DeleteTransferRun(DeleteTransferRunRequest request, CallSettings callSettings = null)

Deletes the specified transfer run.

Parameters
NameDescription
requestDeleteTransferRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteTransferRunAsync(DeleteTransferRunRequest, CallSettings)

public override Task DeleteTransferRunAsync(DeleteTransferRunRequest request, CallSettings callSettings = null)

Deletes the specified transfer run.

Parameters
NameDescription
requestDeleteTransferRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetDataSource(GetDataSourceRequest, CallSettings)

public override DataSource GetDataSource(GetDataSourceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetDataSourceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
DataSource

The RPC response.

Overrides

GetDataSourceAsync(GetDataSourceRequest, CallSettings)

public override Task<DataSource> GetDataSourceAsync(GetDataSourceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGetDataSourceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<DataSource>

A Task containing the RPC response.

Overrides

GetTransferConfig(GetTransferConfigRequest, CallSettings)

public override TransferConfig GetTransferConfig(GetTransferConfigRequest request, CallSettings callSettings = null)

Returns information about a data transfer config.

Parameters
NameDescription
requestGetTransferConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Overrides

GetTransferConfigAsync(GetTransferConfigRequest, CallSettings)

public override Task<TransferConfig> GetTransferConfigAsync(GetTransferConfigRequest request, CallSettings callSettings = null)

Returns information about a data transfer config.

Parameters
NameDescription
requestGetTransferConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Overrides

GetTransferRun(GetTransferRunRequest, CallSettings)

public override TransferRun GetTransferRun(GetTransferRunRequest request, CallSettings callSettings = null)

Returns information about the particular transfer run.

Parameters
NameDescription
requestGetTransferRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferRun

The RPC response.

Overrides

GetTransferRunAsync(GetTransferRunRequest, CallSettings)

public override Task<TransferRun> GetTransferRunAsync(GetTransferRunRequest request, CallSettings callSettings = null)

Returns information about the particular transfer run.

Parameters
NameDescription
requestGetTransferRunRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferRun>

A Task containing the RPC response.

Overrides

ListDataSources(ListDataSourcesRequest, CallSettings)

public override PagedEnumerable<ListDataSourcesResponse, DataSource> ListDataSources(ListDataSourcesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListDataSourcesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListDataSourcesResponse, DataSource>

A pageable sequence of DataSource resources.

Overrides

ListDataSourcesAsync(ListDataSourcesRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> ListDataSourcesAsync(ListDataSourcesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListDataSourcesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource>

A pageable asynchronous sequence of DataSource resources.

Overrides

ListTransferConfigs(ListTransferConfigsRequest, CallSettings)

public override PagedEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigs(ListTransferConfigsRequest request, CallSettings callSettings = null)

Returns information about all data transfers in the project.

Parameters
NameDescription
requestListTransferConfigsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferConfigsResponse, TransferConfig>

A pageable sequence of TransferConfig resources.

Overrides

ListTransferConfigsAsync(ListTransferConfigsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigsAsync(ListTransferConfigsRequest request, CallSettings callSettings = null)

Returns information about all data transfers in the project.

Parameters
NameDescription
requestListTransferConfigsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig>

A pageable asynchronous sequence of TransferConfig resources.

Overrides

ListTransferLogs(ListTransferLogsRequest, CallSettings)

public override PagedEnumerable<ListTransferLogsResponse, TransferMessage> ListTransferLogs(ListTransferLogsRequest request, CallSettings callSettings = null)

Returns user facing log messages for the data transfer run.

Parameters
NameDescription
requestListTransferLogsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferLogsResponse, TransferMessage>

A pageable sequence of TransferMessage resources.

Overrides

ListTransferLogsAsync(ListTransferLogsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage> ListTransferLogsAsync(ListTransferLogsRequest request, CallSettings callSettings = null)

Returns user facing log messages for the data transfer run.

Parameters
NameDescription
requestListTransferLogsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage>

A pageable asynchronous sequence of TransferMessage resources.

Overrides

ListTransferRuns(ListTransferRunsRequest, CallSettings)

public override PagedEnumerable<ListTransferRunsResponse, TransferRun> ListTransferRuns(ListTransferRunsRequest request, CallSettings callSettings = null)

Returns information about running and completed jobs.

Parameters
NameDescription
requestListTransferRunsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferRunsResponse, TransferRun>

A pageable sequence of TransferRun resources.

Overrides

ListTransferRunsAsync(ListTransferRunsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun> ListTransferRunsAsync(ListTransferRunsRequest request, CallSettings callSettings = null)

Returns information about running and completed jobs.

Parameters
NameDescription
requestListTransferRunsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun>

A pageable asynchronous sequence of TransferRun resources.

Overrides

ScheduleTransferRuns(ScheduleTransferRunsRequest, CallSettings)

[Obsolete]
public override ScheduleTransferRunsResponse ScheduleTransferRuns(ScheduleTransferRunsRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestScheduleTransferRunsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScheduleTransferRunsResponse

The RPC response.

Overrides

ScheduleTransferRunsAsync(ScheduleTransferRunsRequest, CallSettings)

[Obsolete]
public override Task<ScheduleTransferRunsResponse> ScheduleTransferRunsAsync(ScheduleTransferRunsRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestScheduleTransferRunsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScheduleTransferRunsResponse>

A Task containing the RPC response.

Overrides

StartManualTransferRuns(StartManualTransferRunsRequest, CallSettings)

public override StartManualTransferRunsResponse StartManualTransferRuns(StartManualTransferRunsRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestStartManualTransferRunsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
StartManualTransferRunsResponse

The RPC response.

Overrides

StartManualTransferRunsAsync(StartManualTransferRunsRequest, CallSettings)

public override Task<StartManualTransferRunsResponse> StartManualTransferRunsAsync(StartManualTransferRunsRequest request, CallSettings callSettings = null)

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.

Parameters
NameDescription
requestStartManualTransferRunsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<StartManualTransferRunsResponse>

A Task containing the RPC response.

Overrides

UpdateTransferConfig(UpdateTransferConfigRequest, CallSettings)

public override TransferConfig UpdateTransferConfig(UpdateTransferConfigRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateTransferConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Overrides

UpdateTransferConfigAsync(UpdateTransferConfigRequest, CallSettings)

public override Task<TransferConfig> UpdateTransferConfigAsync(UpdateTransferConfigRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestUpdateTransferConfigRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Overrides