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
Implements
Inherited Members
Namespace: Google.Apis.BigQueryDataTransfer.v1.Data
Assembly: Google.Apis.BigQueryDataTransfer.v1.dll
Syntax
public class TransferConfig : IDirectResponseSchema

Properties

DataRefreshWindowDays

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.

Declaration
[JsonProperty("dataRefreshWindowDays")]
public virtual int? DataRefreshWindowDays { get; set; }
Property Value
Type Description
int?

DataSourceId

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

Declaration
[JsonProperty("dataSourceId")]
public virtual string DataSourceId { get; set; }
Property Value
Type Description
string

DatasetRegion

Output only. Region in which BigQuery dataset is located.

Declaration
[JsonProperty("datasetRegion")]
public virtual string DatasetRegion { get; set; }
Property Value
Type Description
string

DestinationDatasetId

The BigQuery target dataset id.

Declaration
[JsonProperty("destinationDatasetId")]
public virtual string DestinationDatasetId { get; set; }
Property Value
Type Description
string

Disabled

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

Declaration
[JsonProperty("disabled")]
public virtual bool? Disabled { get; set; }
Property Value
Type Description
bool?

DisplayName

User specified display name for the data transfer.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EmailPreferences

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

Declaration
[JsonProperty("emailPreferences")]
public virtual EmailPreferences EmailPreferences { get; set; }
Property Value
Type Description
EmailPreferences

EncryptionConfiguration

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.

Declaration
[JsonProperty("encryptionConfiguration")]
public virtual EncryptionConfiguration EncryptionConfiguration { get; set; }
Property Value
Type Description
EncryptionConfiguration

Error

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

Declaration
[JsonProperty("error")]
public virtual Status Error { get; set; }
Property Value
Type Description
Status

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NextRunTime

object representation of NextRunTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use NextRunTimeDateTimeOffset instead.")]
public virtual object NextRunTime { get; set; }
Property Value
Type Description
object

NextRunTimeDateTimeOffset

DateTimeOffset representation of NextRunTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? NextRunTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

NextRunTimeRaw

Output only. Next time when data transfer will run.

Declaration
[JsonProperty("nextRunTime")]
public virtual string NextRunTimeRaw { get; set; }
Property Value
Type Description
string

NotificationPubsubTopic

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}

Declaration
[JsonProperty("notificationPubsubTopic")]
public virtual string NotificationPubsubTopic { get; set; }
Property Value
Type Description
string

OwnerInfo

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.

Declaration
[JsonProperty("ownerInfo")]
public virtual UserInfo OwnerInfo { get; set; }
Property Value
Type Description
UserInfo

Params__

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

Declaration
[JsonProperty("params")]
public virtual IDictionary<string, object> Params__ { get; set; }
Property Value
Type Description
IDictionary<string, object>

Schedule

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.

Declaration
[JsonProperty("schedule")]
public virtual string Schedule { get; set; }
Property Value
Type Description
string

ScheduleOptions

Options customizing the data transfer schedule.

Declaration
[JsonProperty("scheduleOptions")]
public virtual ScheduleOptions ScheduleOptions { get; set; }
Property Value
Type Description
ScheduleOptions

ScheduleOptionsV2

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

Declaration
[JsonProperty("scheduleOptionsV2")]
public virtual ScheduleOptionsV2 ScheduleOptionsV2 { get; set; }
Property Value
Type Description
ScheduleOptionsV2

State

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

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

UserId

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

Declaration
[JsonProperty("userId")]
public virtual long? UserId { get; set; }
Property Value
Type Description
long?

Implements