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
System.Object
TransferConfig
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
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
System.Nullable<System.Int32>

DatasetRegion

Output only. Region in which BigQuery dataset is located.

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

DataSourceId

Data source id. Cannot be changed once data transfer is created.

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

DestinationDatasetId

The BigQuery target dataset id.

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

Disabled

Is this config disabled. When set to true, no runs are scheduled for a given transfer.

Declaration
[JsonProperty("disabled")]
public virtual bool? Disabled { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>

DisplayName

User specified display name for the data transfer.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
System.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

ETag

The ETag of the item.

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

Name

The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/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
System.String

NextRunTime

Output only. Next time when data transfer will run.

Declaration
[JsonProperty("nextRunTime")]
public virtual object NextRunTime { get; set; }
Property Value
Type Description
System.Object

NotificationPubsubTopic

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

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

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
System.Collections.Generic.IDictionary<System.String, System.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 granularity should be at least 8 hours, or less frequent.

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

ScheduleOptions

Options customizing the data transfer schedule.

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

State

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

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

UpdateTime

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

Declaration
[JsonProperty("updateTime")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
System.Object

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
System.Nullable<System.Int64>

Implements