Struct TransferRun

#[non_exhaustive]
pub struct TransferRun {

    pub name: String,
    pub schedule_time: Option<Timestamp>,
    pub run_time: Option<Timestamp>,
    pub error_status: Option<Status>,
    pub start_time: Option<Timestamp>,
    pub end_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub params: Option<Struct>,
    pub data_source_id: String,
    pub state: TransferState,
    pub user_id: i64,
    pub schedule: String,
    pub notification_pubsub_topic: String,
    pub email_preferences: Option<EmailPreferences>,
    pub destination: Option<Destination>,
    /* private fields */
}

Represents a data transfer run.

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 run. Transfer run names have the form projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.

schedule_time: Option<Timestamp>

Minimum time after which a transfer run can be started.

run_time: Option<Timestamp>

For batch transfer runs, specifies the date and time of the data should be ingested.

error_status: Option<Status>

Status of the transfer run.

start_time: Option<Timestamp>

Output only. Time when transfer run was started. Parameter ignored by server for input requests.

end_time: Option<Timestamp>

Output only. Time when transfer run ended. Parameter ignored by server for input requests.

update_time: Option<Timestamp>

Output only. Last time the data transfer run state was updated.

params: Option<Struct>

Output only. 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

data_source_id: String

Output only. Data source id.

state: TransferState

Data transfer run state. Ignored for input requests.

user_id: i64

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

schedule: String

Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so schedule_time doesn’t always match this.

notification_pubsub_topic: String

Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes.

The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

email_preferences: Option<EmailPreferences>

Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from.

destination: Option<Destination>

Data transfer destination.

Implementations

impl TransferRun

pub fn new() -> Self

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

Sets the value of name.

pub fn set_schedule_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of schedule_time.

pub fn set_run_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of run_time.

pub fn set_error_status<T: Into<Option<Status>>>(self, v: T) -> Self

Sets the value of error_status.

pub fn set_start_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of start_time.

pub fn set_end_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of end_time.

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

Sets the value of update_time.

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

Sets the value of params.

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

Sets the value of data_source_id.

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_schedule<T: Into<String>>(self, v: T) -> Self

Sets the value of schedule.

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: Into<Option<EmailPreferences>>>( self, v: T, ) -> Self

Sets the value of email_preferences.

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 TransferRun

fn clone(&self) -> TransferRun

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransferRun

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

Formats the value using the given formatter.

impl Default for TransferRun

fn default() -> TransferRun

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransferRun

where TransferRun: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for TransferRun

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TransferRun

fn eq(&self, other: &TransferRun) -> 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 Serialize for TransferRun

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TransferRun