public sealed class DataTransferServiceClientImpl : DataTransferServiceClient
DataTransferService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.BigQuery.DataTransfer.V1Assembly
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 | |
---|---|
Name | Description |
grpcClient | DataTransferService.DataTransferServiceClient The underlying gRPC client. |
settings | DataTransferServiceSettings The base DataTransferServiceSettings used within this client. |
Properties
GrpcClient
public override DataTransferService.DataTransferServiceClient GrpcClient { get; }
The underlying gRPC DataTransferService client
Property Value | |
---|---|
Type | Description |
DataTransferService.DataTransferServiceClient |
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 | |
---|---|
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. |
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 | |
---|---|
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 |
Task<CheckValidCredsResponse> | A Task containing the RPC response. |
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. |
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 |
Task<TransferConfig> | A Task containing the RPC response. |
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. |
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. |
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. |
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. |
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 | |
---|---|
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. |
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 | |
---|---|
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 |
Task<DataSource> | A Task containing the RPC response. |
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. |
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 |
Task<TransferConfig> | A Task containing the RPC response. |
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. |
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 |
Task<TransferRun> | A Task containing the RPC response. |
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 | |
---|---|
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 |
PagedEnumerable<ListDataSourcesResponse, DataSource> | A pageable sequence of DataSource resources. |
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 | |
---|---|
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 |
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> | A pageable asynchronous sequence of DataSource resources. |
ListTransferConfigs(ListTransferConfigsRequest, CallSettings)
public override PagedEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigs(ListTransferConfigsRequest request, CallSettings callSettings = null)
Returns information about all data transfers in the project.
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 |
PagedEnumerable<ListTransferConfigsResponse, TransferConfig> | A pageable sequence of TransferConfig resources. |
ListTransferConfigsAsync(ListTransferConfigsRequest, CallSettings)
public override PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigsAsync(ListTransferConfigsRequest request, CallSettings callSettings = null)
Returns information about all data transfers in the project.
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 |
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> | A pageable asynchronous sequence of TransferConfig resources. |
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 | |
---|---|
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 |
PagedEnumerable<ListTransferLogsResponse, TransferMessage> | A pageable sequence of TransferMessage resources. |
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 | |
---|---|
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 |
PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage> | A pageable asynchronous sequence of TransferMessage resources. |
ListTransferRuns(ListTransferRunsRequest, CallSettings)
public override PagedEnumerable<ListTransferRunsResponse, TransferRun> ListTransferRuns(ListTransferRunsRequest request, CallSettings callSettings = null)
Returns information about running and completed jobs.
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 |
PagedEnumerable<ListTransferRunsResponse, TransferRun> | A pageable sequence of TransferRun resources. |
ListTransferRunsAsync(ListTransferRunsRequest, CallSettings)
public override PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun> ListTransferRunsAsync(ListTransferRunsRequest request, CallSettings callSettings = null)
Returns information about running and completed jobs.
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 |
PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun> | A pageable asynchronous sequence of TransferRun resources. |
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. |
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 |
Task<ScheduleTransferRunsResponse> | A Task containing the RPC response. |
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. |
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 |
Task<StartManualTransferRunsResponse> | A Task containing the RPC response. |
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. |
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 |
Task<TransferConfig> | A Task containing the RPC response. |