Google BigQuery Data Transfer v1 API - Class TransferConfig (4.10.0) 

public sealed class TransferConfig : IMessage<TransferConfig>, IEquatable<TransferConfig>, IDeepCloneable<TransferConfig>, IBufferMessage, IMessage

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

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destination_dataset_id specifies where data should be stored. When a new transfer configuration is created, the specified destination_dataset_id is created when needed and shared with the appropriate data source service account.

Inheritance

object > TransferConfig

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

TransferConfig()

public TransferConfig()

TransferConfig(TransferConfig)

public TransferConfig(TransferConfig other)
Parameter
Name Description
other TransferConfig

Properties

DataRefreshWindowDays

public int DataRefreshWindowDays { get; set; }

The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.

Property Value
Type Description
int

DataSourceId

public string DataSourceId { get; set; }

Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

Property Value
Type Description
string

DatasetRegion

public string DatasetRegion { get; set; }

Output only. Region in which BigQuery dataset is located.

Property Value
Type Description
string

DestinationCase

public TransferConfig.DestinationOneofCase DestinationCase { get; }
Property Value
Type Description
TransferConfigDestinationOneofCase

DestinationDatasetId

public string DestinationDatasetId { get; set; }

The BigQuery target dataset id.

Property Value
Type Description
string

Disabled

public bool Disabled { get; set; }

Is this config disabled. When set to true, no runs will be scheduled for this transfer config.

Property Value
Type Description
bool

DisplayName

public string DisplayName { get; set; }

User specified display name for the data transfer.

Property Value
Type Description
string

EmailPreferences

public EmailPreferences EmailPreferences { get; set; }

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

Property Value
Type Description
EmailPreferences

EncryptionConfiguration

public EncryptionConfiguration EncryptionConfiguration { get; set; }

The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

Property Value
Type Description
EncryptionConfiguration

Error

public Status Error { get; set; }

Output only. Error code with detailed information about reason of the latest config failure.

Property Value
Type Description
Status

HasDestinationDatasetId

public bool HasDestinationDatasetId { get; }

Gets whether the "destination_dataset_id" field is set

Property Value
Type Description
bool

Name

public string Name { get; set; }

Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/transferConfigs/{config_id}, where config_id is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

Property Value
Type Description
string

NextRunTime

public Timestamp NextRunTime { get; set; }

Output only. Next time when data transfer will run.

Property Value
Type Description
Timestamp

NotificationPubsubTopic

public string NotificationPubsubTopic { get; set; }

Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

Property Value
Type Description
string

OwnerInfo

public UserInfo OwnerInfo { get; set; }

Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

Property Value
Type Description
UserInfo

Params

public Struct Params { get; set; }

Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq

Property Value
Type Description
Struct

Schedule

public string Schedule { get; set; }

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

Property Value
Type Description
string

ScheduleOptions

public ScheduleOptions ScheduleOptions { get; set; }

Options customizing the data transfer schedule.

Property Value
Type Description
ScheduleOptions

ScheduleOptionsV2

public ScheduleOptionsV2 ScheduleOptionsV2 { get; set; }

Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

Property Value
Type Description
ScheduleOptionsV2

State

public TransferState State { get; set; }

Output only. State of the most recently updated transfer run.

Property Value
Type Description
TransferState

TransferConfigName

public TransferConfigName TransferConfigName { get; set; }

TransferConfigName-typed view over the Name resource name property.

Property Value
Type Description
TransferConfigName

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Data transfer modification time. Ignored by server on input.

Property Value
Type Description
Timestamp

UserId

public long UserId { get; set; }

Deprecated. Unique ID of the user on whose behalf transfer is done.

Property Value
Type Description
long