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 ListExecutionsOutput {
    /// <p><code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>A unique identifier for the workflow.</p>
    pub workflow_id: ::std::string::String,
    /// <p>Returns the details for each execution, in a <code>ListedExecution</code> array.</p>
    pub executions: ::std::vec::Vec<crate::types::ListedExecution>,
    _request_id: Option<String>,
}
impl ListExecutionsOutput {
    /// <p><code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>A unique identifier for the workflow.</p>
    pub fn workflow_id(&self) -> &str {
        use std::ops::Deref;
        self.workflow_id.deref()
    }
    /// <p>Returns the details for each execution, in a <code>ListedExecution</code> array.</p>
    pub fn executions(&self) -> &[crate::types::ListedExecution] {
        use std::ops::Deref;
        self.executions.deref()
    }
}
impl ::aws_types::request_id::RequestId for ListExecutionsOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl ListExecutionsOutput {
    /// Creates a new builder-style object to manufacture [`ListExecutionsOutput`](crate::operation::list_executions::ListExecutionsOutput).
    pub fn builder() -> crate::operation::list_executions::builders::ListExecutionsOutputBuilder {
        crate::operation::list_executions::builders::ListExecutionsOutputBuilder::default()
    }
}

/// A builder for [`ListExecutionsOutput`](crate::operation::list_executions::ListExecutionsOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListExecutionsOutputBuilder {
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) workflow_id: ::std::option::Option<::std::string::String>,
    pub(crate) executions: ::std::option::Option<::std::vec::Vec<crate::types::ListedExecution>>,
    _request_id: Option<String>,
}
impl ListExecutionsOutputBuilder {
    /// <p><code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p>
    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.next_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p><code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p><code>ListExecutions</code> returns the <code>NextToken</code> parameter in the output. You can then pass the <code>NextToken</code> parameter in a subsequent command to continue listing additional executions.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// <p>A unique identifier for the workflow.</p>
    /// This field is required.
    pub fn workflow_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.workflow_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique identifier for the workflow.</p>
    pub fn set_workflow_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.workflow_id = input;
        self
    }
    /// <p>A unique identifier for the workflow.</p>
    pub fn get_workflow_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.workflow_id
    }
    /// Appends an item to `executions`.
    ///
    /// To override the contents of this collection use [`set_executions`](Self::set_executions).
    ///
    /// <p>Returns the details for each execution, in a <code>ListedExecution</code> array.</p>
    pub fn executions(mut self, input: crate::types::ListedExecution) -> Self {
        let mut v = self.executions.unwrap_or_default();
        v.push(input);
        self.executions = ::std::option::Option::Some(v);
        self
    }
    /// <p>Returns the details for each execution, in a <code>ListedExecution</code> array.</p>
    pub fn set_executions(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::ListedExecution>>) -> Self {
        self.executions = input;
        self
    }
    /// <p>Returns the details for each execution, in a <code>ListedExecution</code> array.</p>
    pub fn get_executions(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::ListedExecution>> {
        &self.executions
    }
    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
        self._request_id = Some(request_id.into());
        self
    }

    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
        self._request_id = request_id;
        self
    }
    /// Consumes the builder and constructs a [`ListExecutionsOutput`](crate::operation::list_executions::ListExecutionsOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`workflow_id`](crate::operation::list_executions::builders::ListExecutionsOutputBuilder::workflow_id)
    /// - [`executions`](crate::operation::list_executions::builders::ListExecutionsOutputBuilder::executions)
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::list_executions::ListExecutionsOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_executions::ListExecutionsOutput {
            next_token: self.next_token,
            workflow_id: self.workflow_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "workflow_id",
                    "workflow_id was not specified but it is required when building ListExecutionsOutput",
                )
            })?,
            executions: self.executions.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "executions",
                    "executions was not specified but it is required when building ListExecutionsOutput",
                )
            })?,
            _request_id: self._request_id,
        })
    }
}