Struct TransferConfig 

#[non_exhaustive]
pub struct TransferConfig {

    pub name: String,
    pub display_name: String,
    pub data_source_id: String,
    pub params: Option<Struct>,
    pub schedule: String,
    pub schedule_options: Option<ScheduleOptions>,
    pub schedule_options_v2: Option<ScheduleOptionsV2>,
    pub data_refresh_window_days: i32,
    pub disabled: bool,
    pub update_time: Option<Timestamp>,
    pub next_run_time: Option<Timestamp>,
    pub state: TransferState,
    pub user_id: i64,
    pub dataset_region: String,
    pub notification_pubsub_topic: String,
    pub email_preferences: Option<EmailPreferences>,
    pub owner_info: Option<UserInfo>,
    pub encryption_configuration: Option<EncryptionConfiguration>,
    pub error: Option<Status>,
    pub destination: Option<Destination>,
    /* private fields */
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

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.

display_name: String

User specified display name for the data transfer.

data_source_id: String

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

params: Option<Struct>

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: 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

schedule_options: Option<ScheduleOptions>

Options customizing the data transfer schedule.

schedule_options_v2: Option<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.

data_refresh_window_days: 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.

disabled: bool

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

update_time: Option<Timestamp>

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

next_run_time: Option<Timestamp>

Output only. Next time when data transfer will run.

state: TransferState

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

user_id: i64

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

dataset_region: String

Output only. Region in which BigQuery dataset is located.

notification_pubsub_topic: String

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}

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.

owner_info: Option<UserInfo>

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.

encryption_configuration: Option<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.

error: Option<Status>

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

destination: Option<Destination>

The desination of the transfer config.

Implementations

impl TransferConfig

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_data_source_id<T: Into<String>>(self, v: T) -> Self

Sets the value of data_source_id.

pub fn set_params<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of params.

pub fn set_or_clear_params<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of params.

pub fn set_schedule<T: Into<String>>(self, v: T) -> Self

Sets the value of schedule.

pub fn set_schedule_options<T>(self, v: T) -> Self

where T: Into<ScheduleOptions>,

Sets the value of schedule_options.

pub fn set_or_clear_schedule_options<T>(self, v: Option<T>) -> Self

where T: Into<ScheduleOptions>,

Sets or clears the value of schedule_options.

pub fn set_schedule_options_v2<T>(self, v: T) -> Self

where T: Into<ScheduleOptionsV2>,

Sets the value of schedule_options_v2.

pub fn set_or_clear_schedule_options_v2<T>(self, v: Option<T>) -> Self

where T: Into<ScheduleOptionsV2>,

Sets or clears the value of schedule_options_v2.

pub fn set_data_refresh_window_days<T: Into<i32>>(self, v: T) -> Self

Sets the value of data_refresh_window_days.

pub fn set_disabled<T: Into<bool>>(self, v: T) -> Self

Sets the value of disabled.

pub fn set_update_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of update_time.

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

pub fn set_next_run_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of next_run_time.

pub fn set_or_clear_next_run_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of next_run_time.

pub fn set_state<T: Into<TransferState>>(self, v: T) -> Self

Sets the value of state.

pub fn set_user_id<T: Into<i64>>(self, v: T) -> Self

Sets the value of user_id.

pub fn set_dataset_region<T: Into<String>>(self, v: T) -> Self

Sets the value of dataset_region.

pub fn set_notification_pubsub_topic<T: Into<String>>(self, v: T) -> Self

Sets the value of notification_pubsub_topic.

pub fn set_email_preferences<T>(self, v: T) -> Self

where T: Into<EmailPreferences>,

Sets the value of email_preferences.

pub fn set_or_clear_email_preferences<T>(self, v: Option<T>) -> Self

where T: Into<EmailPreferences>,

Sets or clears the value of email_preferences.

pub fn set_owner_info<T>(self, v: T) -> Self

where T: Into<UserInfo>,

Sets the value of owner_info.

pub fn set_or_clear_owner_info<T>(self, v: Option<T>) -> Self

where T: Into<UserInfo>,

Sets or clears the value of owner_info.

pub fn set_encryption_configuration<T>(self, v: T) -> Self

where T: Into<EncryptionConfiguration>,

Sets the value of encryption_configuration.

pub fn set_or_clear_encryption_configuration<T>(self, v: Option<T>) -> Self

where T: Into<EncryptionConfiguration>,

Sets or clears the value of encryption_configuration.

pub fn set_error<T>(self, v: T) -> Self

where T: Into<Status>,

Sets the value of error.

pub fn set_or_clear_error<T>(self, v: Option<T>) -> Self

where T: Into<Status>,

Sets or clears the value of error.

pub fn set_destination<T: Into<Option<Destination>>>(self, v: T) -> Self

Sets the value of destination.

Note that all the setters affecting destination are mutually exclusive.

pub fn destination_dataset_id(&self) -> Option<&String>

The value of destination if it holds a DestinationDatasetId, None if the field is not set or holds a different branch.

pub fn set_destination_dataset_id<T: Into<String>>(self, v: T) -> Self

Sets the value of destination to hold a DestinationDatasetId.

Note that all the setters affecting destination are mutually exclusive.

Trait Implementations

impl Clone for TransferConfig

fn clone(&self) -> TransferConfig

Returns a duplicate of the value.

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 Message for TransferConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TransferConfig

fn eq(&self, other: &TransferConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for TransferConfig