Class DataTransferServiceClient (3.2.0)

public abstract class DataTransferServiceClient

DataTransferService client wrapper, for convenient use.

Inheritance

Object > DataTransferServiceClient

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.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the DataTransferService service, which is a host of "bigquerydatatransfer.googleapis.com" and a port of 443.

Property Value
TypeDescription
String

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default DataTransferService scopes.

Property Value
TypeDescription
IReadOnlyList<String>
Remarks

The default DataTransferService scopes are:

GrpcClient

public virtual DataTransferService.DataTransferServiceClient GrpcClient { get; }

The underlying gRPC DataTransferService client

Property Value
TypeDescription
DataTransferService.DataTransferServiceClient

Methods

CheckValidCreds(CheckValidCredsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
CheckValidCredsRequest request = new CheckValidCredsRequest
{
    DataSourceName = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]"),
};
// Make the request
CheckValidCredsResponse response = dataTransferServiceClient.CheckValidCreds(request);

CheckValidCreds(DataSourceName, CallSettings)

public virtual CheckValidCredsResponse CheckValidCreds(DataSourceName name, 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
nameDataSourceName

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
CheckValidCredsResponse

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
DataSourceName name = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]");
// Make the request
CheckValidCredsResponse response = dataTransferServiceClient.CheckValidCreds(name);

CheckValidCreds(String, CallSettings)

public virtual CheckValidCredsResponse CheckValidCreds(string name, 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
nameString

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
CheckValidCredsResponse

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/dataSources/[DATA_SOURCE]";
// Make the request
CheckValidCredsResponse response = dataTransferServiceClient.CheckValidCreds(name);

CheckValidCredsAsync(CheckValidCredsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
CheckValidCredsRequest request = new CheckValidCredsRequest
{
    DataSourceName = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]"),
};
// Make the request
CheckValidCredsResponse response = await dataTransferServiceClient.CheckValidCredsAsync(request);

CheckValidCredsAsync(CheckValidCredsRequest, CancellationToken)

public virtual Task<CheckValidCredsResponse> CheckValidCredsAsync(CheckValidCredsRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<CheckValidCredsResponse>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
CheckValidCredsRequest request = new CheckValidCredsRequest
{
    DataSourceName = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]"),
};
// Make the request
CheckValidCredsResponse response = await dataTransferServiceClient.CheckValidCredsAsync(request);

CheckValidCredsAsync(DataSourceName, CallSettings)

public virtual Task<CheckValidCredsResponse> CheckValidCredsAsync(DataSourceName name, 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
nameDataSourceName

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<CheckValidCredsResponse>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
DataSourceName name = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]");
// Make the request
CheckValidCredsResponse response = await dataTransferServiceClient.CheckValidCredsAsync(name);

CheckValidCredsAsync(DataSourceName, CancellationToken)

public virtual Task<CheckValidCredsResponse> CheckValidCredsAsync(DataSourceName name, CancellationToken cancellationToken)

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
nameDataSourceName

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<CheckValidCredsResponse>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
DataSourceName name = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]");
// Make the request
CheckValidCredsResponse response = await dataTransferServiceClient.CheckValidCredsAsync(name);

CheckValidCredsAsync(String, CallSettings)

public virtual Task<CheckValidCredsResponse> CheckValidCredsAsync(string name, 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
nameString

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<CheckValidCredsResponse>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/dataSources/[DATA_SOURCE]";
// Make the request
CheckValidCredsResponse response = await dataTransferServiceClient.CheckValidCredsAsync(name);

CheckValidCredsAsync(String, CancellationToken)

public virtual Task<CheckValidCredsResponse> CheckValidCredsAsync(string name, CancellationToken cancellationToken)

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
nameString

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<CheckValidCredsResponse>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/dataSources/[DATA_SOURCE]";
// Make the request
CheckValidCredsResponse response = await dataTransferServiceClient.CheckValidCredsAsync(name);

Create()

public static DataTransferServiceClient Create()

Synchronously creates a DataTransferServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DataTransferServiceClientBuilder.

Returns
TypeDescription
DataTransferServiceClient

The created DataTransferServiceClient.

CreateAsync(CancellationToken)

public static Task<DataTransferServiceClient> CreateAsync(CancellationToken cancellationToken = default(CancellationToken))

Asynchronously creates a DataTransferServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use DataTransferServiceClientBuilder.

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
Task<DataTransferServiceClient>

The task representing the created DataTransferServiceClient.

CreateTransferConfig(LocationName, TransferConfig, CallSettings)

public virtual TransferConfig CreateTransferConfig(LocationName parent, TransferConfig transferConfig, CallSettings callSettings = null)

Creates a new data transfer configuration.

Parameters
NameDescription
parentLocationName

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = dataTransferServiceClient.CreateTransferConfig(parent, transferConfig);

CreateTransferConfig(ProjectName, TransferConfig, CallSettings)

public virtual TransferConfig CreateTransferConfig(ProjectName parent, TransferConfig transferConfig, CallSettings callSettings = null)

Creates a new data transfer configuration.

Parameters
NameDescription
parentProjectName

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = dataTransferServiceClient.CreateTransferConfig(parent, transferConfig);

CreateTransferConfig(CreateTransferConfigRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
CreateTransferConfigRequest request = new CreateTransferConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    TransferConfig = new TransferConfig(),
    AuthorizationCode = "",
    VersionInfo = "",
    ServiceAccountName = "",
};
// Make the request
TransferConfig response = dataTransferServiceClient.CreateTransferConfig(request);

CreateTransferConfig(String, TransferConfig, CallSettings)

public virtual TransferConfig CreateTransferConfig(string parent, TransferConfig transferConfig, CallSettings callSettings = null)

Creates a new data transfer configuration.

Parameters
NameDescription
parentString

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = dataTransferServiceClient.CreateTransferConfig(parent, transferConfig);

CreateTransferConfigAsync(LocationName, TransferConfig, CallSettings)

public virtual Task<TransferConfig> CreateTransferConfigAsync(LocationName parent, TransferConfig transferConfig, CallSettings callSettings = null)

Creates a new data transfer configuration.

Parameters
NameDescription
parentLocationName

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = await dataTransferServiceClient.CreateTransferConfigAsync(parent, transferConfig);

CreateTransferConfigAsync(LocationName, TransferConfig, CancellationToken)

public virtual Task<TransferConfig> CreateTransferConfigAsync(LocationName parent, TransferConfig transferConfig, CancellationToken cancellationToken)

Creates a new data transfer configuration.

Parameters
NameDescription
parentLocationName

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = await dataTransferServiceClient.CreateTransferConfigAsync(parent, transferConfig);

CreateTransferConfigAsync(ProjectName, TransferConfig, CallSettings)

public virtual Task<TransferConfig> CreateTransferConfigAsync(ProjectName parent, TransferConfig transferConfig, CallSettings callSettings = null)

Creates a new data transfer configuration.

Parameters
NameDescription
parentProjectName

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = await dataTransferServiceClient.CreateTransferConfigAsync(parent, transferConfig);

CreateTransferConfigAsync(ProjectName, TransferConfig, CancellationToken)

public virtual Task<TransferConfig> CreateTransferConfigAsync(ProjectName parent, TransferConfig transferConfig, CancellationToken cancellationToken)

Creates a new data transfer configuration.

Parameters
NameDescription
parentProjectName

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = await dataTransferServiceClient.CreateTransferConfigAsync(parent, transferConfig);

CreateTransferConfigAsync(CreateTransferConfigRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTransferConfigRequest request = new CreateTransferConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    TransferConfig = new TransferConfig(),
    AuthorizationCode = "",
    VersionInfo = "",
    ServiceAccountName = "",
};
// Make the request
TransferConfig response = await dataTransferServiceClient.CreateTransferConfigAsync(request);

CreateTransferConfigAsync(CreateTransferConfigRequest, CancellationToken)

public virtual Task<TransferConfig> CreateTransferConfigAsync(CreateTransferConfigRequest request, CancellationToken cancellationToken)

Creates a new data transfer configuration.

Parameters
NameDescription
requestCreateTransferConfigRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
CreateTransferConfigRequest request = new CreateTransferConfigRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    TransferConfig = new TransferConfig(),
    AuthorizationCode = "",
    VersionInfo = "",
    ServiceAccountName = "",
};
// Make the request
TransferConfig response = await dataTransferServiceClient.CreateTransferConfigAsync(request);

CreateTransferConfigAsync(String, TransferConfig, CallSettings)

public virtual Task<TransferConfig> CreateTransferConfigAsync(string parent, TransferConfig transferConfig, CallSettings callSettings = null)

Creates a new data transfer configuration.

Parameters
NameDescription
parentString

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = await dataTransferServiceClient.CreateTransferConfigAsync(parent, transferConfig);

CreateTransferConfigAsync(String, TransferConfig, CancellationToken)

public virtual Task<TransferConfig> CreateTransferConfigAsync(string parent, TransferConfig transferConfig, CancellationToken cancellationToken)

Creates a new data transfer configuration.

Parameters
NameDescription
parentString

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

transferConfigTransferConfig

Required. Data transfer configuration to create.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
TransferConfig transferConfig = new TransferConfig();
// Make the request
TransferConfig response = await dataTransferServiceClient.CreateTransferConfigAsync(parent, transferConfig);

DeleteTransferConfig(DeleteTransferConfigRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
DeleteTransferConfigRequest request = new DeleteTransferConfigRequest
{
    TransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
};
// Make the request
dataTransferServiceClient.DeleteTransferConfig(request);

DeleteTransferConfig(TransferConfigName, CallSettings)

public virtual void DeleteTransferConfig(TransferConfigName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameTransferConfigName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
TransferConfigName name = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
// Make the request
dataTransferServiceClient.DeleteTransferConfig(name);

DeleteTransferConfig(String, CallSettings)

public virtual void DeleteTransferConfig(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
// Make the request
dataTransferServiceClient.DeleteTransferConfig(name);

DeleteTransferConfigAsync(DeleteTransferConfigRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTransferConfigRequest request = new DeleteTransferConfigRequest
{
    TransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
};
// Make the request
await dataTransferServiceClient.DeleteTransferConfigAsync(request);

DeleteTransferConfigAsync(DeleteTransferConfigRequest, CancellationToken)

public virtual Task DeleteTransferConfigAsync(DeleteTransferConfigRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTransferConfigRequest request = new DeleteTransferConfigRequest
{
    TransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
};
// Make the request
await dataTransferServiceClient.DeleteTransferConfigAsync(request);

DeleteTransferConfigAsync(TransferConfigName, CallSettings)

public virtual Task DeleteTransferConfigAsync(TransferConfigName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameTransferConfigName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
TransferConfigName name = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
// Make the request
await dataTransferServiceClient.DeleteTransferConfigAsync(name);

DeleteTransferConfigAsync(TransferConfigName, CancellationToken)

public virtual Task DeleteTransferConfigAsync(TransferConfigName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameTransferConfigName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
TransferConfigName name = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
// Make the request
await dataTransferServiceClient.DeleteTransferConfigAsync(name);

DeleteTransferConfigAsync(String, CallSettings)

public virtual Task DeleteTransferConfigAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
// Make the request
await dataTransferServiceClient.DeleteTransferConfigAsync(name);

DeleteTransferConfigAsync(String, CancellationToken)

public virtual Task DeleteTransferConfigAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
// Make the request
await dataTransferServiceClient.DeleteTransferConfigAsync(name);

DeleteTransferRun(DeleteTransferRunRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
DeleteTransferRunRequest request = new DeleteTransferRunRequest
{
    RunName = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"),
};
// Make the request
dataTransferServiceClient.DeleteTransferRun(request);

DeleteTransferRun(RunName, CallSettings)

public virtual void DeleteTransferRun(RunName name, CallSettings callSettings = null)

Deletes the specified transfer run.

Parameters
NameDescription
nameRunName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
RunName name = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
// Make the request
dataTransferServiceClient.DeleteTransferRun(name);

DeleteTransferRun(String, CallSettings)

public virtual void DeleteTransferRun(string name, CallSettings callSettings = null)

Deletes the specified transfer run.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]/runs/[RUN]";
// Make the request
dataTransferServiceClient.DeleteTransferRun(name);

DeleteTransferRunAsync(DeleteTransferRunRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTransferRunRequest request = new DeleteTransferRunRequest
{
    RunName = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"),
};
// Make the request
await dataTransferServiceClient.DeleteTransferRunAsync(request);

DeleteTransferRunAsync(DeleteTransferRunRequest, CancellationToken)

public virtual Task DeleteTransferRunAsync(DeleteTransferRunRequest request, CancellationToken cancellationToken)

Deletes the specified transfer run.

Parameters
NameDescription
requestDeleteTransferRunRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteTransferRunRequest request = new DeleteTransferRunRequest
{
    RunName = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"),
};
// Make the request
await dataTransferServiceClient.DeleteTransferRunAsync(request);

DeleteTransferRunAsync(RunName, CallSettings)

public virtual Task DeleteTransferRunAsync(RunName name, CallSettings callSettings = null)

Deletes the specified transfer run.

Parameters
NameDescription
nameRunName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
RunName name = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
// Make the request
await dataTransferServiceClient.DeleteTransferRunAsync(name);

DeleteTransferRunAsync(RunName, CancellationToken)

public virtual Task DeleteTransferRunAsync(RunName name, CancellationToken cancellationToken)

Deletes the specified transfer run.

Parameters
NameDescription
nameRunName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
RunName name = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
// Make the request
await dataTransferServiceClient.DeleteTransferRunAsync(name);

DeleteTransferRunAsync(String, CallSettings)

public virtual Task DeleteTransferRunAsync(string name, CallSettings callSettings = null)

Deletes the specified transfer run.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]/runs/[RUN]";
// Make the request
await dataTransferServiceClient.DeleteTransferRunAsync(name);

DeleteTransferRunAsync(String, CancellationToken)

public virtual Task DeleteTransferRunAsync(string name, CancellationToken cancellationToken)

Deletes the specified transfer run.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]/runs/[RUN]";
// Make the request
await dataTransferServiceClient.DeleteTransferRunAsync(name);

GetDataSource(DataSourceName, CallSettings)

public virtual DataSource GetDataSource(DataSourceName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameDataSourceName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
DataSource

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
DataSourceName name = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]");
// Make the request
DataSource response = dataTransferServiceClient.GetDataSource(name);

GetDataSource(GetDataSourceRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
GetDataSourceRequest request = new GetDataSourceRequest
{
    DataSourceName = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]"),
};
// Make the request
DataSource response = dataTransferServiceClient.GetDataSource(request);

GetDataSource(String, CallSettings)

public virtual DataSource GetDataSource(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
DataSource

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/dataSources/[DATA_SOURCE]";
// Make the request
DataSource response = dataTransferServiceClient.GetDataSource(name);

GetDataSourceAsync(DataSourceName, CallSettings)

public virtual Task<DataSource> GetDataSourceAsync(DataSourceName name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameDataSourceName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<DataSource>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
DataSourceName name = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]");
// Make the request
DataSource response = await dataTransferServiceClient.GetDataSourceAsync(name);

GetDataSourceAsync(DataSourceName, CancellationToken)

public virtual Task<DataSource> GetDataSourceAsync(DataSourceName name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameDataSourceName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<DataSource>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
DataSourceName name = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]");
// Make the request
DataSource response = await dataTransferServiceClient.GetDataSourceAsync(name);

GetDataSourceAsync(GetDataSourceRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataSourceRequest request = new GetDataSourceRequest
{
    DataSourceName = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]"),
};
// Make the request
DataSource response = await dataTransferServiceClient.GetDataSourceAsync(request);

GetDataSourceAsync(GetDataSourceRequest, CancellationToken)

public virtual Task<DataSource> GetDataSourceAsync(GetDataSourceRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<DataSource>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
GetDataSourceRequest request = new GetDataSourceRequest
{
    DataSourceName = DataSourceName.FromProjectDataSource("[PROJECT]", "[DATA_SOURCE]"),
};
// Make the request
DataSource response = await dataTransferServiceClient.GetDataSourceAsync(request);

GetDataSourceAsync(String, CallSettings)

public virtual Task<DataSource> GetDataSourceAsync(string name, CallSettings callSettings = null)

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

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<DataSource>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/dataSources/[DATA_SOURCE]";
// Make the request
DataSource response = await dataTransferServiceClient.GetDataSourceAsync(name);

GetDataSourceAsync(String, CancellationToken)

public virtual Task<DataSource> GetDataSourceAsync(string name, CancellationToken cancellationToken)

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

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<DataSource>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/dataSources/[DATA_SOURCE]";
// Make the request
DataSource response = await dataTransferServiceClient.GetDataSourceAsync(name);

GetTransferConfig(GetTransferConfigRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
GetTransferConfigRequest request = new GetTransferConfigRequest
{
    TransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
};
// Make the request
TransferConfig response = dataTransferServiceClient.GetTransferConfig(request);

GetTransferConfig(TransferConfigName, CallSettings)

public virtual TransferConfig GetTransferConfig(TransferConfigName name, CallSettings callSettings = null)

Returns information about a data transfer config.

Parameters
NameDescription
nameTransferConfigName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
TransferConfigName name = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
// Make the request
TransferConfig response = dataTransferServiceClient.GetTransferConfig(name);

GetTransferConfig(String, CallSettings)

public virtual TransferConfig GetTransferConfig(string name, CallSettings callSettings = null)

Returns information about a data transfer config.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
// Make the request
TransferConfig response = dataTransferServiceClient.GetTransferConfig(name);

GetTransferConfigAsync(GetTransferConfigRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
GetTransferConfigRequest request = new GetTransferConfigRequest
{
    TransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
};
// Make the request
TransferConfig response = await dataTransferServiceClient.GetTransferConfigAsync(request);

GetTransferConfigAsync(GetTransferConfigRequest, CancellationToken)

public virtual Task<TransferConfig> GetTransferConfigAsync(GetTransferConfigRequest request, CancellationToken cancellationToken)

Returns information about a data transfer config.

Parameters
NameDescription
requestGetTransferConfigRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
GetTransferConfigRequest request = new GetTransferConfigRequest
{
    TransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
};
// Make the request
TransferConfig response = await dataTransferServiceClient.GetTransferConfigAsync(request);

GetTransferConfigAsync(TransferConfigName, CallSettings)

public virtual Task<TransferConfig> GetTransferConfigAsync(TransferConfigName name, CallSettings callSettings = null)

Returns information about a data transfer config.

Parameters
NameDescription
nameTransferConfigName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
TransferConfigName name = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
// Make the request
TransferConfig response = await dataTransferServiceClient.GetTransferConfigAsync(name);

GetTransferConfigAsync(TransferConfigName, CancellationToken)

public virtual Task<TransferConfig> GetTransferConfigAsync(TransferConfigName name, CancellationToken cancellationToken)

Returns information about a data transfer config.

Parameters
NameDescription
nameTransferConfigName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
TransferConfigName name = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
// Make the request
TransferConfig response = await dataTransferServiceClient.GetTransferConfigAsync(name);

GetTransferConfigAsync(String, CallSettings)

public virtual Task<TransferConfig> GetTransferConfigAsync(string name, CallSettings callSettings = null)

Returns information about a data transfer config.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
// Make the request
TransferConfig response = await dataTransferServiceClient.GetTransferConfigAsync(name);

GetTransferConfigAsync(String, CancellationToken)

public virtual Task<TransferConfig> GetTransferConfigAsync(string name, CancellationToken cancellationToken)

Returns information about a data transfer config.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
// Make the request
TransferConfig response = await dataTransferServiceClient.GetTransferConfigAsync(name);

GetTransferRun(GetTransferRunRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
GetTransferRunRequest request = new GetTransferRunRequest
{
    RunName = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"),
};
// Make the request
TransferRun response = dataTransferServiceClient.GetTransferRun(request);

GetTransferRun(RunName, CallSettings)

public virtual TransferRun GetTransferRun(RunName name, CallSettings callSettings = null)

Returns information about the particular transfer run.

Parameters
NameDescription
nameRunName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferRun

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
RunName name = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
// Make the request
TransferRun response = dataTransferServiceClient.GetTransferRun(name);

GetTransferRun(String, CallSettings)

public virtual TransferRun GetTransferRun(string name, CallSettings callSettings = null)

Returns information about the particular transfer run.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferRun

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]/runs/[RUN]";
// Make the request
TransferRun response = dataTransferServiceClient.GetTransferRun(name);

GetTransferRunAsync(GetTransferRunRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
GetTransferRunRequest request = new GetTransferRunRequest
{
    RunName = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"),
};
// Make the request
TransferRun response = await dataTransferServiceClient.GetTransferRunAsync(request);

GetTransferRunAsync(GetTransferRunRequest, CancellationToken)

public virtual Task<TransferRun> GetTransferRunAsync(GetTransferRunRequest request, CancellationToken cancellationToken)

Returns information about the particular transfer run.

Parameters
NameDescription
requestGetTransferRunRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferRun>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
GetTransferRunRequest request = new GetTransferRunRequest
{
    RunName = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"),
};
// Make the request
TransferRun response = await dataTransferServiceClient.GetTransferRunAsync(request);

GetTransferRunAsync(RunName, CallSettings)

public virtual Task<TransferRun> GetTransferRunAsync(RunName name, CallSettings callSettings = null)

Returns information about the particular transfer run.

Parameters
NameDescription
nameRunName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferRun>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
RunName name = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
// Make the request
TransferRun response = await dataTransferServiceClient.GetTransferRunAsync(name);

GetTransferRunAsync(RunName, CancellationToken)

public virtual Task<TransferRun> GetTransferRunAsync(RunName name, CancellationToken cancellationToken)

Returns information about the particular transfer run.

Parameters
NameDescription
nameRunName

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferRun>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
RunName name = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
// Make the request
TransferRun response = await dataTransferServiceClient.GetTransferRunAsync(name);

GetTransferRunAsync(String, CallSettings)

public virtual Task<TransferRun> GetTransferRunAsync(string name, CallSettings callSettings = null)

Returns information about the particular transfer run.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferRun>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]/runs/[RUN]";
// Make the request
TransferRun response = await dataTransferServiceClient.GetTransferRunAsync(name);

GetTransferRunAsync(String, CancellationToken)

public virtual Task<TransferRun> GetTransferRunAsync(string name, CancellationToken cancellationToken)

Returns information about the particular transfer run.

Parameters
NameDescription
nameString

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferRun>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]/runs/[RUN]";
// Make the request
TransferRun response = await dataTransferServiceClient.GetTransferRunAsync(name);

ListDataSources(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListDataSourcesResponse, DataSource> ListDataSources(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListDataSourcesResponse, DataSource>

A pageable sequence of DataSource resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListDataSourcesResponse, DataSource> response = dataTransferServiceClient.ListDataSources(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataSource item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataSourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataSource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataSource> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataSource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataSources(ProjectName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListDataSourcesResponse, DataSource> ListDataSources(ProjectName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentProjectName

Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListDataSourcesResponse, DataSource>

A pageable sequence of DataSource resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListDataSourcesResponse, DataSource> response = dataTransferServiceClient.ListDataSources(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataSource item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataSourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataSource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataSource> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataSource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataSources(ListDataSourcesRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
ListDataSourcesRequest request = new ListDataSourcesRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedEnumerable<ListDataSourcesResponse, DataSource> response = dataTransferServiceClient.ListDataSources(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataSource item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataSourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataSource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataSource> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataSource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataSources(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListDataSourcesResponse, DataSource> ListDataSources(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListDataSourcesResponse, DataSource>

A pageable sequence of DataSource resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListDataSourcesResponse, DataSource> response = dataTransferServiceClient.ListDataSources(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (DataSource item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListDataSourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataSource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataSource> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataSource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataSourcesAsync(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> ListDataSourcesAsync(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource>

A pageable asynchronous sequence of DataSource resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> response = dataTransferServiceClient.ListDataSourcesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataSource item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataSourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataSource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataSource> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataSource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataSourcesAsync(ProjectName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> ListDataSourcesAsync(ProjectName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentProjectName

Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource>

A pageable asynchronous sequence of DataSource resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> response = dataTransferServiceClient.ListDataSourcesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataSource item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataSourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataSource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataSource> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataSource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataSourcesAsync(ListDataSourcesRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
ListDataSourcesRequest request = new ListDataSourcesRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> response = dataTransferServiceClient.ListDataSourcesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataSource item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataSourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataSource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataSource> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataSource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListDataSourcesAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> ListDataSourcesAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or `projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource>

A pageable asynchronous sequence of DataSource resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListDataSourcesResponse, DataSource> response = dataTransferServiceClient.ListDataSourcesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((DataSource item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDataSourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (DataSource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<DataSource> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (DataSource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferConfigs(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigs(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferConfigsResponse, TransferConfig>

A pageable sequence of TransferConfig resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListTransferConfigsResponse, TransferConfig> response = dataTransferServiceClient.ListTransferConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferConfigs(ProjectName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigs(ProjectName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentProjectName

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferConfigsResponse, TransferConfig>

A pageable sequence of TransferConfig resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListTransferConfigsResponse, TransferConfig> response = dataTransferServiceClient.ListTransferConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferConfigs(ListTransferConfigsRequest, CallSettings)

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

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

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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
ListTransferConfigsRequest request = new ListTransferConfigsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    DataSourceIds = { "", },
};
// Make the request
PagedEnumerable<ListTransferConfigsResponse, TransferConfig> response = dataTransferServiceClient.ListTransferConfigs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferConfigs(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigs(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferConfigsResponse, TransferConfig>

A pageable sequence of TransferConfig resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListTransferConfigsResponse, TransferConfig> response = dataTransferServiceClient.ListTransferConfigs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferConfig item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferConfigsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferConfig> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferConfigsAsync(LocationName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigsAsync(LocationName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentLocationName

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig>

A pageable asynchronous sequence of TransferConfig resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> response = dataTransferServiceClient.ListTransferConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferConfigsAsync(ProjectName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigsAsync(ProjectName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentProjectName

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig>

A pageable asynchronous sequence of TransferConfig resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> response = dataTransferServiceClient.ListTransferConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferConfigsAsync(ListTransferConfigsRequest, CallSettings)

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

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

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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
ListTransferConfigsRequest request = new ListTransferConfigsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    DataSourceIds = { "", },
};
// Make the request
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> response = dataTransferServiceClient.ListTransferConfigsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferConfigsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> ListTransferConfigsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

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

Parameters
NameDescription
parentString

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig>

A pageable asynchronous sequence of TransferConfig resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListTransferConfigsResponse, TransferConfig> response = dataTransferServiceClient.ListTransferConfigsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferConfig item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferConfigsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferConfig item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferConfig> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferConfig item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferLogs(ListTransferLogsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
ListTransferLogsRequest request = new ListTransferLogsRequest
{
    ParentAsRunName = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"),
    MessageTypes =
    {
        TransferMessage.Types.MessageSeverity.Unspecified,
    },
};
// Make the request
PagedEnumerable<ListTransferLogsResponse, TransferMessage> response = dataTransferServiceClient.ListTransferLogs(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferMessage item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferLogsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferMessage item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferMessage> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferMessage item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferLogs(RunName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListTransferLogsResponse, TransferMessage> ListTransferLogs(RunName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns user facing log messages for the data transfer run.

Parameters
NameDescription
parentRunName

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferLogsResponse, TransferMessage>

A pageable sequence of TransferMessage resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
RunName parent = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
// Make the request
PagedEnumerable<ListTransferLogsResponse, TransferMessage> response = dataTransferServiceClient.ListTransferLogs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferMessage item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferLogsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferMessage item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferMessage> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferMessage item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferLogs(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListTransferLogsResponse, TransferMessage> ListTransferLogs(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns user facing log messages for the data transfer run.

Parameters
NameDescription
parentString

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferLogsResponse, TransferMessage>

A pageable sequence of TransferMessage resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]/runs/[RUN]";
// Make the request
PagedEnumerable<ListTransferLogsResponse, TransferMessage> response = dataTransferServiceClient.ListTransferLogs(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferMessage item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferLogsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferMessage item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferMessage> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferMessage item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferLogsAsync(ListTransferLogsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
ListTransferLogsRequest request = new ListTransferLogsRequest
{
    ParentAsRunName = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"),
    MessageTypes =
    {
        TransferMessage.Types.MessageSeverity.Unspecified,
    },
};
// Make the request
PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage> response = dataTransferServiceClient.ListTransferLogsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferMessage item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferLogsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferMessage item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferMessage> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferMessage item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferLogsAsync(RunName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage> ListTransferLogsAsync(RunName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns user facing log messages for the data transfer run.

Parameters
NameDescription
parentRunName

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage>

A pageable asynchronous sequence of TransferMessage resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
RunName parent = RunName.FromProjectTransferConfigRun("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]");
// Make the request
PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage> response = dataTransferServiceClient.ListTransferLogsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferMessage item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferLogsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferMessage item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferMessage> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferMessage item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferLogsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage> ListTransferLogsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns user facing log messages for the data transfer run.

Parameters
NameDescription
parentString

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage>

A pageable asynchronous sequence of TransferMessage resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]/runs/[RUN]";
// Make the request
PagedAsyncEnumerable<ListTransferLogsResponse, TransferMessage> response = dataTransferServiceClient.ListTransferLogsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferMessage item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferLogsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferMessage item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferMessage> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferMessage item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferRuns(ListTransferRunsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
ListTransferRunsRequest request = new ListTransferRunsRequest
{
    ParentAsTransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
    States =
    {
        TransferState.Unspecified,
    },
    RunAttempt = ListTransferRunsRequest.Types.RunAttempt.Unspecified,
};
// Make the request
PagedEnumerable<ListTransferRunsResponse, TransferRun> response = dataTransferServiceClient.ListTransferRuns(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferRun item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferRunsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferRun> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferRuns(TransferConfigName, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListTransferRunsResponse, TransferRun> ListTransferRuns(TransferConfigName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns information about running and completed jobs.

Parameters
NameDescription
parentTransferConfigName

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferRunsResponse, TransferRun>

A pageable sequence of TransferRun resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
TransferConfigName parent = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
// Make the request
PagedEnumerable<ListTransferRunsResponse, TransferRun> response = dataTransferServiceClient.ListTransferRuns(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferRun item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferRunsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferRun> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferRuns(String, String, Nullable<Int32>, CallSettings)

public virtual PagedEnumerable<ListTransferRunsResponse, TransferRun> ListTransferRuns(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns information about running and completed jobs.

Parameters
NameDescription
parentString

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListTransferRunsResponse, TransferRun>

A pageable sequence of TransferRun resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
// Make the request
PagedEnumerable<ListTransferRunsResponse, TransferRun> response = dataTransferServiceClient.ListTransferRuns(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (TransferRun item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListTransferRunsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferRun> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferRunsAsync(ListTransferRunsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
ListTransferRunsRequest request = new ListTransferRunsRequest
{
    ParentAsTransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
    States =
    {
        TransferState.Unspecified,
    },
    RunAttempt = ListTransferRunsRequest.Types.RunAttempt.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun> response = dataTransferServiceClient.ListTransferRunsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferRun item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferRunsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferRun> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferRunsAsync(TransferConfigName, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun> ListTransferRunsAsync(TransferConfigName parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns information about running and completed jobs.

Parameters
NameDescription
parentTransferConfigName

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun>

A pageable asynchronous sequence of TransferRun resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
TransferConfigName parent = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
// Make the request
PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun> response = dataTransferServiceClient.ListTransferRunsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferRun item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferRunsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferRun> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListTransferRunsAsync(String, String, Nullable<Int32>, CallSettings)

public virtual PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun> ListTransferRunsAsync(string parent, string pageToken = null, int? pageSize = default(int? ), CallSettings callSettings = null)

Returns information about running and completed jobs.

Parameters
NameDescription
parentString

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

pageTokenString

The token returned from the previous request. A value of null or an empty string retrieves the first page.

pageSizeNullable<Int32>

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun>

A pageable asynchronous sequence of TransferRun resources.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
// Make the request
PagedAsyncEnumerable<ListTransferRunsResponse, TransferRun> response = dataTransferServiceClient.ListTransferRunsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((TransferRun item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListTransferRunsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (TransferRun item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<TransferRun> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (TransferRun item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ScheduleTransferRuns(ScheduleTransferRunsRequest, CallSettings)

[Obsolete]
public virtual 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.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
            // Initialize request argument(s)
            ScheduleTransferRunsRequest request = new ScheduleTransferRunsRequest
            {
                ParentAsTransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
                StartTime = new Timestamp(),
                EndTime = new Timestamp(),
            };
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = dataTransferServiceClient.ScheduleTransferRuns(request);
#pragma warning restore CS0612

ScheduleTransferRuns(TransferConfigName, Timestamp, Timestamp, CallSettings)

[Obsolete]
public virtual ScheduleTransferRunsResponse ScheduleTransferRuns(TransferConfigName parent, Timestamp startTime, Timestamp endTime, 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
parentTransferConfigName

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

startTimeTimestamp

Required. Start time of the range of transfer runs. For example, &quot;2017-05-25T00:00:00+00:00&quot;.

endTimeTimestamp

Required. End time of the range of transfer runs. For example, &quot;2017-05-30T00:00:00+00:00&quot;.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScheduleTransferRunsResponse

The RPC response.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
            // Initialize request argument(s)
            TransferConfigName parent = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
            Timestamp startTime = new Timestamp();
            Timestamp endTime = new Timestamp();
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = dataTransferServiceClient.ScheduleTransferRuns(parent, startTime, endTime);
#pragma warning restore CS0612

ScheduleTransferRuns(String, Timestamp, Timestamp, CallSettings)

[Obsolete]
public virtual ScheduleTransferRunsResponse ScheduleTransferRuns(string parent, Timestamp startTime, Timestamp endTime, 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
parentString

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

startTimeTimestamp

Required. Start time of the range of transfer runs. For example, &quot;2017-05-25T00:00:00+00:00&quot;.

endTimeTimestamp

Required. End time of the range of transfer runs. For example, &quot;2017-05-30T00:00:00+00:00&quot;.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ScheduleTransferRunsResponse

The RPC response.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
            // Initialize request argument(s)
            string parent = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
            Timestamp startTime = new Timestamp();
            Timestamp endTime = new Timestamp();
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = dataTransferServiceClient.ScheduleTransferRuns(parent, startTime, endTime);
#pragma warning restore CS0612

ScheduleTransferRunsAsync(ScheduleTransferRunsRequest, CallSettings)

[Obsolete]
public virtual 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.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
            // Initialize request argument(s)
            ScheduleTransferRunsRequest request = new ScheduleTransferRunsRequest
            {
                ParentAsTransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
                StartTime = new Timestamp(),
                EndTime = new Timestamp(),
            };
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = await dataTransferServiceClient.ScheduleTransferRunsAsync(request);
#pragma warning restore CS0612

ScheduleTransferRunsAsync(ScheduleTransferRunsRequest, CancellationToken)

[Obsolete]
public virtual Task<ScheduleTransferRunsResponse> ScheduleTransferRunsAsync(ScheduleTransferRunsRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ScheduleTransferRunsResponse>

A Task containing the RPC response.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
            // Initialize request argument(s)
            ScheduleTransferRunsRequest request = new ScheduleTransferRunsRequest
            {
                ParentAsTransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
                StartTime = new Timestamp(),
                EndTime = new Timestamp(),
            };
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = await dataTransferServiceClient.ScheduleTransferRunsAsync(request);
#pragma warning restore CS0612

ScheduleTransferRunsAsync(TransferConfigName, Timestamp, Timestamp, CallSettings)

[Obsolete]
public virtual Task<ScheduleTransferRunsResponse> ScheduleTransferRunsAsync(TransferConfigName parent, Timestamp startTime, Timestamp endTime, 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
parentTransferConfigName

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

startTimeTimestamp

Required. Start time of the range of transfer runs. For example, &quot;2017-05-25T00:00:00+00:00&quot;.

endTimeTimestamp

Required. End time of the range of transfer runs. For example, &quot;2017-05-30T00:00:00+00:00&quot;.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScheduleTransferRunsResponse>

A Task containing the RPC response.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
            // Initialize request argument(s)
            TransferConfigName parent = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
            Timestamp startTime = new Timestamp();
            Timestamp endTime = new Timestamp();
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = await dataTransferServiceClient.ScheduleTransferRunsAsync(parent, startTime, endTime);
#pragma warning restore CS0612

ScheduleTransferRunsAsync(TransferConfigName, Timestamp, Timestamp, CancellationToken)

[Obsolete]
public virtual Task<ScheduleTransferRunsResponse> ScheduleTransferRunsAsync(TransferConfigName parent, Timestamp startTime, Timestamp endTime, CancellationToken cancellationToken)

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
parentTransferConfigName

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

startTimeTimestamp

Required. Start time of the range of transfer runs. For example, &quot;2017-05-25T00:00:00+00:00&quot;.

endTimeTimestamp

Required. End time of the range of transfer runs. For example, &quot;2017-05-30T00:00:00+00:00&quot;.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ScheduleTransferRunsResponse>

A Task containing the RPC response.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
            // Initialize request argument(s)
            TransferConfigName parent = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]");
            Timestamp startTime = new Timestamp();
            Timestamp endTime = new Timestamp();
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = await dataTransferServiceClient.ScheduleTransferRunsAsync(parent, startTime, endTime);
#pragma warning restore CS0612

ScheduleTransferRunsAsync(String, Timestamp, Timestamp, CallSettings)

[Obsolete]
public virtual Task<ScheduleTransferRunsResponse> ScheduleTransferRunsAsync(string parent, Timestamp startTime, Timestamp endTime, 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
parentString

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

startTimeTimestamp

Required. Start time of the range of transfer runs. For example, &quot;2017-05-25T00:00:00+00:00&quot;.

endTimeTimestamp

Required. End time of the range of transfer runs. For example, &quot;2017-05-30T00:00:00+00:00&quot;.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<ScheduleTransferRunsResponse>

A Task containing the RPC response.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
            // Initialize request argument(s)
            string parent = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
            Timestamp startTime = new Timestamp();
            Timestamp endTime = new Timestamp();
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = await dataTransferServiceClient.ScheduleTransferRunsAsync(parent, startTime, endTime);
#pragma warning restore CS0612

ScheduleTransferRunsAsync(String, Timestamp, Timestamp, CancellationToken)

[Obsolete]
public virtual Task<ScheduleTransferRunsResponse> ScheduleTransferRunsAsync(string parent, Timestamp startTime, Timestamp endTime, CancellationToken cancellationToken)

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
parentString

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

startTimeTimestamp

Required. Start time of the range of transfer runs. For example, &quot;2017-05-25T00:00:00+00:00&quot;.

endTimeTimestamp

Required. End time of the range of transfer runs. For example, &quot;2017-05-30T00:00:00+00:00&quot;.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<ScheduleTransferRunsResponse>

A Task containing the RPC response.

Example
            // Create client
            DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
            // Initialize request argument(s)
            string parent = "projects/[PROJECT]/transferConfigs/[TRANSFER_CONFIG]";
            Timestamp startTime = new Timestamp();
            Timestamp endTime = new Timestamp();
            // Make the request
#pragma warning disable CS0612
            ScheduleTransferRunsResponse response = await dataTransferServiceClient.ScheduleTransferRunsAsync(parent, startTime, endTime);
#pragma warning restore CS0612

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
TypeDescription
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

StartManualTransferRuns(StartManualTransferRunsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
StartManualTransferRunsRequest request = new StartManualTransferRunsRequest
{
    ParentAsTransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
    RequestedTimeRange = new StartManualTransferRunsRequest.Types.TimeRange(),
};
// Make the request
StartManualTransferRunsResponse response = dataTransferServiceClient.StartManualTransferRuns(request);

StartManualTransferRunsAsync(StartManualTransferRunsRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
StartManualTransferRunsRequest request = new StartManualTransferRunsRequest
{
    ParentAsTransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
    RequestedTimeRange = new StartManualTransferRunsRequest.Types.TimeRange(),
};
// Make the request
StartManualTransferRunsResponse response = await dataTransferServiceClient.StartManualTransferRunsAsync(request);

StartManualTransferRunsAsync(StartManualTransferRunsRequest, CancellationToken)

public virtual Task<StartManualTransferRunsResponse> StartManualTransferRunsAsync(StartManualTransferRunsRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<StartManualTransferRunsResponse>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
StartManualTransferRunsRequest request = new StartManualTransferRunsRequest
{
    ParentAsTransferConfigName = TransferConfigName.FromProjectTransferConfig("[PROJECT]", "[TRANSFER_CONFIG]"),
    RequestedTimeRange = new StartManualTransferRunsRequest.Types.TimeRange(),
};
// Make the request
StartManualTransferRunsResponse response = await dataTransferServiceClient.StartManualTransferRunsAsync(request);

UpdateTransferConfig(TransferConfig, FieldMask, CallSettings)

public virtual TransferConfig UpdateTransferConfig(TransferConfig transferConfig, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
NameDescription
transferConfigTransferConfig

Required. Data transfer configuration to create.

updateMaskFieldMask

Required. Required list of fields to be updated in this request.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TransferConfig

The RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
TransferConfig transferConfig = new TransferConfig();
FieldMask updateMask = new FieldMask();
// Make the request
TransferConfig response = dataTransferServiceClient.UpdateTransferConfig(transferConfig, updateMask);

UpdateTransferConfig(UpdateTransferConfigRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.Create();
// Initialize request argument(s)
UpdateTransferConfigRequest request = new UpdateTransferConfigRequest
{
    TransferConfig = new TransferConfig(),
    AuthorizationCode = "",
    UpdateMask = new FieldMask(),
    VersionInfo = "",
    ServiceAccountName = "",
};
// Make the request
TransferConfig response = dataTransferServiceClient.UpdateTransferConfig(request);

UpdateTransferConfigAsync(TransferConfig, FieldMask, CallSettings)

public virtual Task<TransferConfig> UpdateTransferConfigAsync(TransferConfig transferConfig, FieldMask updateMask, CallSettings callSettings = null)

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

Parameters
NameDescription
transferConfigTransferConfig

Required. Data transfer configuration to create.

updateMaskFieldMask

Required. Required list of fields to be updated in this request.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
TransferConfig transferConfig = new TransferConfig();
FieldMask updateMask = new FieldMask();
// Make the request
TransferConfig response = await dataTransferServiceClient.UpdateTransferConfigAsync(transferConfig, updateMask);

UpdateTransferConfigAsync(TransferConfig, FieldMask, CancellationToken)

public virtual Task<TransferConfig> UpdateTransferConfigAsync(TransferConfig transferConfig, FieldMask updateMask, CancellationToken cancellationToken)

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

Parameters
NameDescription
transferConfigTransferConfig

Required. Data transfer configuration to create.

updateMaskFieldMask

Required. Required list of fields to be updated in this request.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
TransferConfig transferConfig = new TransferConfig();
FieldMask updateMask = new FieldMask();
// Make the request
TransferConfig response = await dataTransferServiceClient.UpdateTransferConfigAsync(transferConfig, updateMask);

UpdateTransferConfigAsync(UpdateTransferConfigRequest, CallSettings)

public virtual 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.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTransferConfigRequest request = new UpdateTransferConfigRequest
{
    TransferConfig = new TransferConfig(),
    AuthorizationCode = "",
    UpdateMask = new FieldMask(),
    VersionInfo = "",
    ServiceAccountName = "",
};
// Make the request
TransferConfig response = await dataTransferServiceClient.UpdateTransferConfigAsync(request);

UpdateTransferConfigAsync(UpdateTransferConfigRequest, CancellationToken)

public virtual Task<TransferConfig> UpdateTransferConfigAsync(UpdateTransferConfigRequest request, CancellationToken cancellationToken)

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.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
Task<TransferConfig>

A Task containing the RPC response.

Example
// Create client
DataTransferServiceClient dataTransferServiceClient = await DataTransferServiceClient.CreateAsync();
// Initialize request argument(s)
UpdateTransferConfigRequest request = new UpdateTransferConfigRequest
{
    TransferConfig = new TransferConfig(),
    AuthorizationCode = "",
    UpdateMask = new FieldMask(),
    VersionInfo = "",
    ServiceAccountName = "",
};
// Make the request
TransferConfig response = await dataTransferServiceClient.UpdateTransferConfigAsync(request);