aws_sdk_transfer/operation/create_workflow/

_create_workflow_input.rs

// 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 CreateWorkflowInput {
    /// <p>A textual description for the workflow.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>Specifies the details for the steps that are in the specified workflow.</p>
    /// <p>The <code>TYPE</code> specifies which of the following actions is being taken for this step.</p>
    /// <ul>
    /// <li>
    /// <p><b> <code>COPY</code> </b> - Copy the file to another location.</p></li>
    /// <li>
    /// <p><b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p></li>
    /// <li>
    /// <p><b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p></li>
    /// <li>
    /// <p><b> <code>DELETE</code> </b> - Delete the file.</p></li>
    /// <li>
    /// <p><b> <code>TAG</code> </b> - Add a tag to the file.</p></li>
    /// </ul><note>
    /// <p>Currently, copying and tagging are supported only on S3.</p>
    /// </note>
    /// <p>For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.</p>
    pub steps: ::std::option::Option<::std::vec::Vec<crate::types::WorkflowStep>>,
    /// <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p><note>
    /// <p>For custom steps, the Lambda function needs to send <code>FAILURE</code> to the call back API to kick off the exception steps. Additionally, if the Lambda does not send <code>SUCCESS</code> before it times out, the exception steps are executed.</p>
    /// </note>
    pub on_exception_steps: ::std::option::Option<::std::vec::Vec<crate::types::WorkflowStep>>,
    /// <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>
    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateWorkflowInput {
    /// <p>A textual description for the workflow.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>Specifies the details for the steps that are in the specified workflow.</p>
    /// <p>The <code>TYPE</code> specifies which of the following actions is being taken for this step.</p>
    /// <ul>
    /// <li>
    /// <p><b> <code>COPY</code> </b> - Copy the file to another location.</p></li>
    /// <li>
    /// <p><b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p></li>
    /// <li>
    /// <p><b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p></li>
    /// <li>
    /// <p><b> <code>DELETE</code> </b> - Delete the file.</p></li>
    /// <li>
    /// <p><b> <code>TAG</code> </b> - Add a tag to the file.</p></li>
    /// </ul><note>
    /// <p>Currently, copying and tagging are supported only on S3.</p>
    /// </note>
    /// <p>For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.</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 `.steps.is_none()`.
    pub fn steps(&self) -> &[crate::types::WorkflowStep] {
        self.steps.as_deref().unwrap_or_default()
    }
    /// <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p><note>
    /// <p>For custom steps, the Lambda function needs to send <code>FAILURE</code> to the call back API to kick off the exception steps. Additionally, if the Lambda does not send <code>SUCCESS</code> before it times out, the exception steps are executed.</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 `.on_exception_steps.is_none()`.
    pub fn on_exception_steps(&self) -> &[crate::types::WorkflowStep] {
        self.on_exception_steps.as_deref().unwrap_or_default()
    }
    /// <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</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 `.tags.is_none()`.
    pub fn tags(&self) -> &[crate::types::Tag] {
        self.tags.as_deref().unwrap_or_default()
    }
}
impl CreateWorkflowInput {
    /// Creates a new builder-style object to manufacture [`CreateWorkflowInput`](crate::operation::create_workflow::CreateWorkflowInput).
    pub fn builder() -> crate::operation::create_workflow::builders::CreateWorkflowInputBuilder {
        crate::operation::create_workflow::builders::CreateWorkflowInputBuilder::default()
    }
}

/// A builder for [`CreateWorkflowInput`](crate::operation::create_workflow::CreateWorkflowInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateWorkflowInputBuilder {
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) steps: ::std::option::Option<::std::vec::Vec<crate::types::WorkflowStep>>,
    pub(crate) on_exception_steps: ::std::option::Option<::std::vec::Vec<crate::types::WorkflowStep>>,
    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
}
impl CreateWorkflowInputBuilder {
    /// <p>A textual description for the workflow.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A textual description for the workflow.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>A textual description for the workflow.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// Appends an item to `steps`.
    ///
    /// To override the contents of this collection use [`set_steps`](Self::set_steps).
    ///
    /// <p>Specifies the details for the steps that are in the specified workflow.</p>
    /// <p>The <code>TYPE</code> specifies which of the following actions is being taken for this step.</p>
    /// <ul>
    /// <li>
    /// <p><b> <code>COPY</code> </b> - Copy the file to another location.</p></li>
    /// <li>
    /// <p><b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p></li>
    /// <li>
    /// <p><b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p></li>
    /// <li>
    /// <p><b> <code>DELETE</code> </b> - Delete the file.</p></li>
    /// <li>
    /// <p><b> <code>TAG</code> </b> - Add a tag to the file.</p></li>
    /// </ul><note>
    /// <p>Currently, copying and tagging are supported only on S3.</p>
    /// </note>
    /// <p>For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.</p>
    pub fn steps(mut self, input: crate::types::WorkflowStep) -> Self {
        let mut v = self.steps.unwrap_or_default();
        v.push(input);
        self.steps = ::std::option::Option::Some(v);
        self
    }
    /// <p>Specifies the details for the steps that are in the specified workflow.</p>
    /// <p>The <code>TYPE</code> specifies which of the following actions is being taken for this step.</p>
    /// <ul>
    /// <li>
    /// <p><b> <code>COPY</code> </b> - Copy the file to another location.</p></li>
    /// <li>
    /// <p><b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p></li>
    /// <li>
    /// <p><b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p></li>
    /// <li>
    /// <p><b> <code>DELETE</code> </b> - Delete the file.</p></li>
    /// <li>
    /// <p><b> <code>TAG</code> </b> - Add a tag to the file.</p></li>
    /// </ul><note>
    /// <p>Currently, copying and tagging are supported only on S3.</p>
    /// </note>
    /// <p>For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.</p>
    pub fn set_steps(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::WorkflowStep>>) -> Self {
        self.steps = input;
        self
    }
    /// <p>Specifies the details for the steps that are in the specified workflow.</p>
    /// <p>The <code>TYPE</code> specifies which of the following actions is being taken for this step.</p>
    /// <ul>
    /// <li>
    /// <p><b> <code>COPY</code> </b> - Copy the file to another location.</p></li>
    /// <li>
    /// <p><b> <code>CUSTOM</code> </b> - Perform a custom step with an Lambda function target.</p></li>
    /// <li>
    /// <p><b> <code>DECRYPT</code> </b> - Decrypt a file that was encrypted before it was uploaded.</p></li>
    /// <li>
    /// <p><b> <code>DELETE</code> </b> - Delete the file.</p></li>
    /// <li>
    /// <p><b> <code>TAG</code> </b> - Add a tag to the file.</p></li>
    /// </ul><note>
    /// <p>Currently, copying and tagging are supported only on S3.</p>
    /// </note>
    /// <p>For file location, you specify either the Amazon S3 bucket and key, or the Amazon EFS file system ID and path.</p>
    pub fn get_steps(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::WorkflowStep>> {
        &self.steps
    }
    /// Appends an item to `on_exception_steps`.
    ///
    /// To override the contents of this collection use [`set_on_exception_steps`](Self::set_on_exception_steps).
    ///
    /// <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p><note>
    /// <p>For custom steps, the Lambda function needs to send <code>FAILURE</code> to the call back API to kick off the exception steps. Additionally, if the Lambda does not send <code>SUCCESS</code> before it times out, the exception steps are executed.</p>
    /// </note>
    pub fn on_exception_steps(mut self, input: crate::types::WorkflowStep) -> Self {
        let mut v = self.on_exception_steps.unwrap_or_default();
        v.push(input);
        self.on_exception_steps = ::std::option::Option::Some(v);
        self
    }
    /// <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p><note>
    /// <p>For custom steps, the Lambda function needs to send <code>FAILURE</code> to the call back API to kick off the exception steps. Additionally, if the Lambda does not send <code>SUCCESS</code> before it times out, the exception steps are executed.</p>
    /// </note>
    pub fn set_on_exception_steps(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::WorkflowStep>>) -> Self {
        self.on_exception_steps = input;
        self
    }
    /// <p>Specifies the steps (actions) to take if errors are encountered during execution of the workflow.</p><note>
    /// <p>For custom steps, the Lambda function needs to send <code>FAILURE</code> to the call back API to kick off the exception steps. Additionally, if the Lambda does not send <code>SUCCESS</code> before it times out, the exception steps are executed.</p>
    /// </note>
    pub fn get_on_exception_steps(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::WorkflowStep>> {
        &self.on_exception_steps
    }
    /// Appends an item to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>
    pub fn tags(mut self, input: crate::types::Tag) -> Self {
        let mut v = self.tags.unwrap_or_default();
        v.push(input);
        self.tags = ::std::option::Option::Some(v);
        self
    }
    /// <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`CreateWorkflowInput`](crate::operation::create_workflow::CreateWorkflowInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_workflow::CreateWorkflowInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::create_workflow::CreateWorkflowInput {
            description: self.description,
            steps: self.steps,
            on_exception_steps: self.on_exception_steps,
            tags: self.tags,
        })
    }
}