Struct google_bigquerydatatransfer1::api::TransferConfig

pub struct TransferConfig {
    pub data_refresh_window_days: Option<i32>,
    pub data_source_id: Option<String>,
    pub dataset_region: Option<String>,
    pub destination_dataset_id: Option<String>,
    pub disabled: Option<bool>,
    pub display_name: Option<String>,
    pub email_preferences: Option<EmailPreferences>,
    pub name: Option<String>,
    pub next_run_time: Option<String>,
    pub notification_pubsub_topic: Option<String>,
    pub params: Option<HashMap<String, String>>,
    pub schedule: Option<String>,
    pub schedule_options: Option<ScheduleOptions>,
    pub state: Option<String>,
    pub update_time: Option<String>,
    pub user_id: Option<String>,
}

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.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations transfer configs create projects (request|response)
• locations transfer configs get projects (response)
• locations transfer configs patch projects (request|response)
• transfer configs create projects (request|response)
• transfer configs get projects (response)
• transfer configs patch projects (request|response)

Fields

data_refresh_window_days: Option<i32>

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.

data_source_id: Option<String>

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

dataset_region: Option<String>

Output only. Region in which BigQuery dataset is located.

destination_dataset_id: Option<String>

The BigQuery target dataset id.

disabled: Option<bool>

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

display_name: Option<String>

User specified display name for the data transfer.

email_preferences: Option<EmailPreferences>

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

name: Option<String>

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.

next_run_time: Option<String>

Output only. Next time when data transfer will run.

notification_pubsub_topic: Option<String>

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

params: Option<HashMap<String, String>>

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

schedule: Option<String>

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.

schedule_options: Option<ScheduleOptions>

Options customizing the data transfer schedule.

state: Option<String>

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

update_time: Option<String>

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

user_id: Option<String>

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

Trait Implementations

impl Clone for TransferConfig

fn clone(&self) -> TransferConfig

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TransferConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TransferConfig

fn default() -> TransferConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransferConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl RequestValue for TransferConfig

impl ResponseResult for TransferConfig

impl Serialize for TransferConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.