Struct googapis::google::cloud::bigquery::datatransfer::v1::TransferConfig

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 data_refresh_window_days: i32,
    pub disabled: bool,
    pub update_time: Option<Timestamp>,
    pub next_run_time: Option<Timestamp>,
    pub state: i32,
    pub user_id: i64,
    pub dataset_region: String,
    pub notification_pubsub_topic: String,
    pub email_preferences: Option<EmailPreferences>,
    pub destination: Option<Destination>,
}

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

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

display_name: String

User specified display name for the data transfer.

data_source_id: String

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

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

schedule_options: Option<ScheduleOptions>

Options customizing the data transfer 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 are scheduled for a given transfer.

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: i32

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}/topics/{topic}

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.

destination: Option<Destination>

The desination of the transfer config.

Implementations

impl TransferConfig

pub fn state(&self) -> TransferState

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: TransferState)

Sets state to the provided enum value.

Trait Implementations

impl Clone for TransferConfig

fn clone(&self) -> TransferConfig

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for TransferConfig

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<TransferConfig> for TransferConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for TransferConfig