Class TransferConfig (3.1.0)

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

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

IMessage<TransferConfig>, IEquatable<TransferConfig>, IDeepCloneable<TransferConfig>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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
`Int32`

DatasetRegion

public string DatasetRegion { get; set; }

Output only. Region in which BigQuery dataset is located.

Property Value
Type	Description
`String`

DataSourceId

public string DataSourceId { get; set; }

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

Property Value
Type	Description
`String`

DestinationCase

public TransferConfig.DestinationOneofCase DestinationCase { get; }

Property Value
Type	Description
`TransferConfig.DestinationOneofCase`

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 are scheduled for a given transfer.

Property Value
Type	Description
`Boolean`

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`

Name

public string Name { get; set; }

The resource name of the transfer config. Transfer config names have the form of projects/{project_id}/locations/{region}/transferConfigs/{config_id}. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.

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.

Property Value
Type	Description
`String`

Params

public Struct Params { get; set; }

Data transfer specific parameters.

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

Property Value
Type	Description
`String`

ScheduleOptions

public ScheduleOptions ScheduleOptions { get; set; }

Options customizing the data transfer schedule.

Property Value
Type	Description
`ScheduleOptions`

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
`Int64`