aws-sdk-transfer 1.113.0

AWS SDK for AWS Transfer Family
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct StartFileTransferInput {
    /// <p>The unique identifier for the connector.</p>
    pub connector_id: ::std::option::Option<::std::string::String>,
    /// <p>One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, <code> <i>amzn-s3-demo-bucket</i>/<i>myfile.txt</i> </code>.</p><note>
    /// <p>Replace <code> <i>amzn-s3-demo-bucket</i> </code> with one of your actual buckets.</p>
    /// </note>
    pub send_file_paths: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.</p>
    pub retrieve_file_paths: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files that are transferred from the partner's SFTP server.</p>
    pub local_directory_path: ::std::option::Option<::std::string::String>,
    /// <p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a <code>RemoteDirectoryPath</code>, the destination for transferred files is the SFTP user's home directory.</p>
    pub remote_directory_path: ::std::option::Option<::std::string::String>,
    /// <p>An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.</p>
    pub custom_http_headers: ::std::option::Option<::std::vec::Vec<crate::types::CustomHttpHeader>>,
}
impl StartFileTransferInput {
    /// <p>The unique identifier for the connector.</p>
    pub fn connector_id(&self) -> ::std::option::Option<&str> {
        self.connector_id.as_deref()
    }
    /// <p>One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, <code> <i>amzn-s3-demo-bucket</i>/<i>myfile.txt</i> </code>.</p><note>
    /// <p>Replace <code> <i>amzn-s3-demo-bucket</i> </code> with one of your actual buckets.</p>
    /// </note>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.send_file_paths.is_none()`.
    pub fn send_file_paths(&self) -> &[::std::string::String] {
        self.send_file_paths.as_deref().unwrap_or_default()
    }
    /// <p>One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.retrieve_file_paths.is_none()`.
    pub fn retrieve_file_paths(&self) -> &[::std::string::String] {
        self.retrieve_file_paths.as_deref().unwrap_or_default()
    }
    /// <p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files that are transferred from the partner's SFTP server.</p>
    pub fn local_directory_path(&self) -> ::std::option::Option<&str> {
        self.local_directory_path.as_deref()
    }
    /// <p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a <code>RemoteDirectoryPath</code>, the destination for transferred files is the SFTP user's home directory.</p>
    pub fn remote_directory_path(&self) -> ::std::option::Option<&str> {
        self.remote_directory_path.as_deref()
    }
    /// <p>An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.custom_http_headers.is_none()`.
    pub fn custom_http_headers(&self) -> &[crate::types::CustomHttpHeader] {
        self.custom_http_headers.as_deref().unwrap_or_default()
    }
}
impl StartFileTransferInput {
    /// Creates a new builder-style object to manufacture [`StartFileTransferInput`](crate::operation::start_file_transfer::StartFileTransferInput).
    pub fn builder() -> crate::operation::start_file_transfer::builders::StartFileTransferInputBuilder {
        crate::operation::start_file_transfer::builders::StartFileTransferInputBuilder::default()
    }
}

/// A builder for [`StartFileTransferInput`](crate::operation::start_file_transfer::StartFileTransferInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct StartFileTransferInputBuilder {
    pub(crate) connector_id: ::std::option::Option<::std::string::String>,
    pub(crate) send_file_paths: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) retrieve_file_paths: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) local_directory_path: ::std::option::Option<::std::string::String>,
    pub(crate) remote_directory_path: ::std::option::Option<::std::string::String>,
    pub(crate) custom_http_headers: ::std::option::Option<::std::vec::Vec<crate::types::CustomHttpHeader>>,
}
impl StartFileTransferInputBuilder {
    /// <p>The unique identifier for the connector.</p>
    /// This field is required.
    pub fn connector_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.connector_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique identifier for the connector.</p>
    pub fn set_connector_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.connector_id = input;
        self
    }
    /// <p>The unique identifier for the connector.</p>
    pub fn get_connector_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.connector_id
    }
    /// Appends an item to `send_file_paths`.
    ///
    /// To override the contents of this collection use [`set_send_file_paths`](Self::set_send_file_paths).
    ///
    /// <p>One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, <code> <i>amzn-s3-demo-bucket</i>/<i>myfile.txt</i> </code>.</p><note>
    /// <p>Replace <code> <i>amzn-s3-demo-bucket</i> </code> with one of your actual buckets.</p>
    /// </note>
    pub fn send_file_paths(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.send_file_paths.unwrap_or_default();
        v.push(input.into());
        self.send_file_paths = ::std::option::Option::Some(v);
        self
    }
    /// <p>One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, <code> <i>amzn-s3-demo-bucket</i>/<i>myfile.txt</i> </code>.</p><note>
    /// <p>Replace <code> <i>amzn-s3-demo-bucket</i> </code> with one of your actual buckets.</p>
    /// </note>
    pub fn set_send_file_paths(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.send_file_paths = input;
        self
    }
    /// <p>One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, <code> <i>amzn-s3-demo-bucket</i>/<i>myfile.txt</i> </code>.</p><note>
    /// <p>Replace <code> <i>amzn-s3-demo-bucket</i> </code> with one of your actual buckets.</p>
    /// </note>
    pub fn get_send_file_paths(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.send_file_paths
    }
    /// Appends an item to `retrieve_file_paths`.
    ///
    /// To override the contents of this collection use [`set_retrieve_file_paths`](Self::set_retrieve_file_paths).
    ///
    /// <p>One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.</p>
    pub fn retrieve_file_paths(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.retrieve_file_paths.unwrap_or_default();
        v.push(input.into());
        self.retrieve_file_paths = ::std::option::Option::Some(v);
        self
    }
    /// <p>One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.</p>
    pub fn set_retrieve_file_paths(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.retrieve_file_paths = input;
        self
    }
    /// <p>One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.</p>
    pub fn get_retrieve_file_paths(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.retrieve_file_paths
    }
    /// <p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files that are transferred from the partner's SFTP server.</p>
    pub fn local_directory_path(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.local_directory_path = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files that are transferred from the partner's SFTP server.</p>
    pub fn set_local_directory_path(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.local_directory_path = input;
        self
    }
    /// <p>For an inbound transfer, the <code>LocaDirectoryPath</code> specifies the destination for one or more files that are transferred from the partner's SFTP server.</p>
    pub fn get_local_directory_path(&self) -> &::std::option::Option<::std::string::String> {
        &self.local_directory_path
    }
    /// <p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a <code>RemoteDirectoryPath</code>, the destination for transferred files is the SFTP user's home directory.</p>
    pub fn remote_directory_path(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.remote_directory_path = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a <code>RemoteDirectoryPath</code>, the destination for transferred files is the SFTP user's home directory.</p>
    pub fn set_remote_directory_path(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.remote_directory_path = input;
        self
    }
    /// <p>For an outbound transfer, the <code>RemoteDirectoryPath</code> specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a <code>RemoteDirectoryPath</code>, the destination for transferred files is the SFTP user's home directory.</p>
    pub fn get_remote_directory_path(&self) -> &::std::option::Option<::std::string::String> {
        &self.remote_directory_path
    }
    /// Appends an item to `custom_http_headers`.
    ///
    /// To override the contents of this collection use [`set_custom_http_headers`](Self::set_custom_http_headers).
    ///
    /// <p>An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.</p>
    pub fn custom_http_headers(mut self, input: crate::types::CustomHttpHeader) -> Self {
        let mut v = self.custom_http_headers.unwrap_or_default();
        v.push(input);
        self.custom_http_headers = ::std::option::Option::Some(v);
        self
    }
    /// <p>An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.</p>
    pub fn set_custom_http_headers(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::CustomHttpHeader>>) -> Self {
        self.custom_http_headers = input;
        self
    }
    /// <p>An array of key-value pairs that represent custom HTTP headers to include in AS2 messages. These headers are added to the AS2 message when sending files to your trading partner.</p>
    pub fn get_custom_http_headers(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::CustomHttpHeader>> {
        &self.custom_http_headers
    }
    /// Consumes the builder and constructs a [`StartFileTransferInput`](crate::operation::start_file_transfer::StartFileTransferInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::start_file_transfer::StartFileTransferInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::start_file_transfer::StartFileTransferInput {
            connector_id: self.connector_id,
            send_file_paths: self.send_file_paths,
            retrieve_file_paths: self.retrieve_file_paths,
            local_directory_path: self.local_directory_path,
            remote_directory_path: self.remote_directory_path,
            custom_http_headers: self.custom_http_headers,
        })
    }
}