Google BigQuery Data Transfer v1 API - Class DataTransferServiceClientImpl (4.8.0)

public sealed class DataTransferServiceClientImpl : DataTransferServiceClient

Reference documentation and code samples for the Google BigQuery Data Transfer v1 API class DataTransferServiceClientImpl.

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

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

Constructors

DataTransferServiceClientImpl(DataTransferServiceClient, DataTransferServiceSettings, ILogger)

public DataTransferServiceClientImpl(DataTransferService.DataTransferServiceClient grpcClient, DataTransferServiceSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient DataTransferServiceDataTransferServiceClient

The underlying gRPC client.
settings DataTransferServiceSettings

The base DataTransferServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override DataTransferService.DataTransferServiceClient GrpcClient { get; }

The underlying gRPC DataTransferService client

Property Value
Type Description
DataTransferServiceDataTransferServiceClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
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.

Parameters
Name Description
request CheckValidCredsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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.

Parameters
Name Description
request CheckValidCredsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskCheckValidCredsResponse

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
Name Description
request CreateTransferConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request CreateTransferConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTransferConfig

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
Name Description
request DeleteTransferConfigRequest

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

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
Name Description
request DeleteTransferConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request DeleteTransferRunRequest

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

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
Name Description
request DeleteTransferRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

EnrollDataSources(EnrollDataSourcesRequest, CallSettings)

public override void EnrollDataSources(EnrollDataSourcesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request EnrollDataSourcesRequest

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

If not null, applies overrides to this RPC call.
Overrides

EnrollDataSourcesAsync(EnrollDataSourcesRequest, CallSettings)

public override Task EnrollDataSourcesAsync(EnrollDataSourcesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request EnrollDataSourcesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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.

Parameters
Name Description
request GetDataSourceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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.

Parameters
Name Description
request GetDataSourceRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataSource

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
Name Description
request GetTransferConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request GetTransferConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTransferConfig

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
Name Description
request GetTransferRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request GetTransferRunRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTransferRun

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.

Parameters
Name Description
request ListDataSourcesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDataSourcesResponseDataSource

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.

Parameters
Name Description
request ListDataSourcesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDataSourcesResponseDataSource

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

Parameters
Name Description
request ListTransferConfigsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTransferConfigsResponseTransferConfig

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

Parameters
Name Description
request ListTransferConfigsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTransferConfigsResponseTransferConfig

A pageable asynchronous sequence of TransferConfig resources.
Overrides

ListTransferLogs(ListTransferLogsRequest, CallSettings)

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

Returns log messages for the transfer run.

Parameters
Name Description
request ListTransferLogsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTransferLogsResponseTransferMessage

A pageable sequence of TransferMessage resources.
Overrides

ListTransferLogsAsync(ListTransferLogsRequest, CallSettings)

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

Returns log messages for the transfer run.

Parameters
Name Description
request ListTransferLogsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTransferLogsResponseTransferMessage

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 transfer runs.

Parameters
Name Description
request ListTransferRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTransferRunsResponseTransferRun

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 transfer runs.

Parameters
Name Description
request ListTransferRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTransferRunsResponseTransferRun

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
Name Description
request ScheduleTransferRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request ScheduleTransferRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskScheduleTransferRunsResponse

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
Name Description
request StartManualTransferRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request StartManualTransferRunsRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskStartManualTransferRunsResponse

A Task containing the RPC response.
Overrides

UnenrollDataSources(UnenrollDataSourcesRequest, CallSettings)

public override void UnenrollDataSources(UnenrollDataSourcesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UnenrollDataSourcesRequest

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

If not null, applies overrides to this RPC call.
Overrides

UnenrollDataSourcesAsync(UnenrollDataSourcesRequest, CallSettings)

public override Task UnenrollDataSourcesAsync(UnenrollDataSourcesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request UnenrollDataSourcesRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

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
Name Description
request UpdateTransferConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
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
Name Description
request UpdateTransferConfigRequest

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

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTransferConfig

A Task containing the RPC response.
Overrides