Google BigQuery Data Transfer v1 API - Class DataTransferService.DataTransferServiceBase (4.6.0)

Version 4.6.0

• 4.10.0 (latest)
• 4.9.0
• 4.8.0
• 4.7.0
• 4.6.0
• 4.5.0
• 4.4.0
• 4.3.0
• 4.2.0
• 4.1.0
• 4.0.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0

[BindServiceMethod(typeof(DataTransferService), "BindService")]
public abstract class DataTransferService.DataTransferServiceBase

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

Base class for server-side implementations of DataTransferService

Inheritance

object > DataTransferService.DataTransferServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Methods

CheckValidCreds(CheckValidCredsRequest, ServerCallContext)

public virtual Task<CheckValidCredsResponse> CheckValidCreds(CheckValidCredsRequest request, ServerCallContext context)

Returns true if valid credentials exist for the given data source and requesting user.

Parameters
Name	Description
request	CheckValidCredsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskCheckValidCredsResponse	The response to send back to the client (wrapped by a task).

CreateTransferConfig(CreateTransferConfigRequest, ServerCallContext)

public virtual Task<TransferConfig> CreateTransferConfig(CreateTransferConfigRequest request, ServerCallContext context)

Creates a new data transfer configuration.

Parameters
Name	Description
request	CreateTransferConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTransferConfig	The response to send back to the client (wrapped by a task).

DeleteTransferConfig(DeleteTransferConfigRequest, ServerCallContext)

public virtual Task<Empty> DeleteTransferConfig(DeleteTransferConfigRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DeleteTransferConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteTransferRun(DeleteTransferRunRequest, ServerCallContext)

public virtual Task<Empty> DeleteTransferRun(DeleteTransferRunRequest request, ServerCallContext context)

Deletes the specified transfer run.

Parameters
Name	Description
request	DeleteTransferRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

EnrollDataSources(EnrollDataSourcesRequest, ServerCallContext)

public virtual Task<Empty> EnrollDataSources(EnrollDataSourcesRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

GetDataSource(GetDataSourceRequest, ServerCallContext)

public virtual Task<DataSource> GetDataSource(GetDataSourceRequest request, ServerCallContext context)

Retrieves a supported data source and returns its settings.

Parameters
Name	Description
request	GetDataSourceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDataSource	The response to send back to the client (wrapped by a task).

GetTransferConfig(GetTransferConfigRequest, ServerCallContext)

public virtual Task<TransferConfig> GetTransferConfig(GetTransferConfigRequest request, ServerCallContext context)

Returns information about a data transfer config.

Parameters
Name	Description
request	GetTransferConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTransferConfig	The response to send back to the client (wrapped by a task).

GetTransferRun(GetTransferRunRequest, ServerCallContext)

public virtual Task<TransferRun> GetTransferRun(GetTransferRunRequest request, ServerCallContext context)

Returns information about the particular transfer run.

Parameters
Name	Description
request	GetTransferRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTransferRun	The response to send back to the client (wrapped by a task).

ListDataSources(ListDataSourcesRequest, ServerCallContext)

public virtual Task<ListDataSourcesResponse> ListDataSources(ListDataSourcesRequest request, ServerCallContext context)

Lists supported data sources and returns their settings.

Parameters
Name	Description
request	ListDataSourcesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListDataSourcesResponse	The response to send back to the client (wrapped by a task).

ListTransferConfigs(ListTransferConfigsRequest, ServerCallContext)

public virtual Task<ListTransferConfigsResponse> ListTransferConfigs(ListTransferConfigsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListTransferConfigsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTransferConfigsResponse	The response to send back to the client (wrapped by a task).

ListTransferLogs(ListTransferLogsRequest, ServerCallContext)

public virtual Task<ListTransferLogsResponse> ListTransferLogs(ListTransferLogsRequest request, ServerCallContext context)

Returns log messages for the transfer run.

Parameters
Name	Description
request	ListTransferLogsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTransferLogsResponse	The response to send back to the client (wrapped by a task).

ListTransferRuns(ListTransferRunsRequest, ServerCallContext)

public virtual Task<ListTransferRunsResponse> ListTransferRuns(ListTransferRunsRequest request, ServerCallContext context)

Returns information about running and completed transfer runs.

Parameters
Name	Description
request	ListTransferRunsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListTransferRunsResponse	The response to send back to the client (wrapped by a task).

ScheduleTransferRuns(ScheduleTransferRunsRequest, ServerCallContext)

[Obsolete]
public virtual Task<ScheduleTransferRunsResponse> ScheduleTransferRuns(ScheduleTransferRunsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScheduleTransferRunsResponse	The response to send back to the client (wrapped by a task).

StartManualTransferRuns(StartManualTransferRunsRequest, ServerCallContext)

public virtual Task<StartManualTransferRunsResponse> StartManualTransferRuns(StartManualTransferRunsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskStartManualTransferRunsResponse	The response to send back to the client (wrapped by a task).

UnenrollDataSources(UnenrollDataSourcesRequest, ServerCallContext)

public virtual Task<Empty> UnenrollDataSources(UnenrollDataSourcesRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

UpdateTransferConfig(UpdateTransferConfigRequest, ServerCallContext)

public virtual Task<TransferConfig> UpdateTransferConfig(UpdateTransferConfigRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateTransferConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTransferConfig	The response to send back to the client (wrapped by a task).