Struct google_api_proto::google::cloud::bigquery::datatransfer::v1::TransferRun

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: i32,
    pub user_id: i64,
    pub schedule: String,
    pub notification_pubsub_topic: String,
    pub email_preferences: Option<EmailPreferences>,
    pub destination: Option<Destination>,
}

Represents a data transfer run.

Fields

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

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 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 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() -> Self

Returns the “default value” for a type.

impl Message for TransferRun

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for TransferRun

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

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

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

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

impl StructuralPartialEq for TransferRun