Struct ConnectorFileTransferResult

#[non_exhaustive]
pub struct ConnectorFileTransferResult {
    pub file_path: String,
    pub status_code: TransferTableStatus,
    pub failure_code: Option<String>,
    pub failure_message: Option<String>,
}

A structure that contains the details for files transferred using an SFTP connector, during a single transfer.

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.

file_path: String

The filename and path to where the file was sent to or retrieved from.

status_code: TransferTableStatus

The current status for the transfer.

failure_code: Option<String>

For transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

failure_message: Option<String>

For transfers that fail, this parameter describes the reason for the failure.

Implementations

impl ConnectorFileTransferResult

pub fn file_path(&self) -> &str

The filename and path to where the file was sent to or retrieved from.

pub fn status_code(&self) -> &TransferTableStatus

The current status for the transfer.

pub fn failure_code(&self) -> Option<&str>

For transfers that fail, this parameter contains a code indicating the reason. For example, RETRIEVE_FILE_NOT_FOUND

pub fn failure_message(&self) -> Option<&str>

For transfers that fail, this parameter describes the reason for the failure.

impl ConnectorFileTransferResult

pub fn builder() -> ConnectorFileTransferResultBuilder

Creates a new builder-style object to manufacture ConnectorFileTransferResult.

Trait Implementations

impl Clone for ConnectorFileTransferResult

fn clone(&self) -> ConnectorFileTransferResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectorFileTransferResult

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

Formats the value using the given formatter.

impl PartialEq for ConnectorFileTransferResult

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