aws-sdk-sfn 1.107.0

// 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)]
pub struct StartSyncExecutionOutput {
    /// <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
    pub execution_arn: ::std::string::String,
    /// <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
    pub state_machine_arn: ::std::option::Option<::std::string::String>,
    /// <p>The name of the execution.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The date the execution is started.</p>
    pub start_date: ::aws_smithy_types::DateTime,
    /// <p>If the execution has already ended, the date the execution stopped.</p>
    pub stop_date: ::aws_smithy_types::DateTime,
    /// <p>The current status of the execution.</p>
    pub status: crate::types::SyncExecutionStatus,
    /// <p>The error code of the failure.</p>
    pub error: ::std::option::Option<::std::string::String>,
    /// <p>A more detailed explanation of the cause of the failure.</p>
    pub cause: ::std::option::Option<::std::string::String>,
    /// <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
    pub input: ::std::option::Option<::std::string::String>,
    /// <p>Provides details about execution input or output.</p>
    pub input_details: ::std::option::Option<crate::types::CloudWatchEventsExecutionDataDetails>,
    /// <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p><note>
    /// <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p>
    /// </note>
    pub output: ::std::option::Option<::std::string::String>,
    /// <p>Provides details about execution input or output.</p>
    pub output_details: ::std::option::Option<crate::types::CloudWatchEventsExecutionDataDetails>,
    /// <p>The X-Ray trace header that was passed to the execution.</p><note>
    /// <p>For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.</p>
    /// </note>
    pub trace_header: ::std::option::Option<::std::string::String>,
    /// <p>An object that describes workflow billing details, including billed duration and memory use.</p>
    pub billing_details: ::std::option::Option<crate::types::BillingDetails>,
    _request_id: Option<String>,
}
impl StartSyncExecutionOutput {
    /// <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
    pub fn execution_arn(&self) -> &str {
        use std::ops::Deref;
        self.execution_arn.deref()
    }
    /// <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
    pub fn state_machine_arn(&self) -> ::std::option::Option<&str> {
        self.state_machine_arn.as_deref()
    }
    /// <p>The name of the execution.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The date the execution is started.</p>
    pub fn start_date(&self) -> &::aws_smithy_types::DateTime {
        &self.start_date
    }
    /// <p>If the execution has already ended, the date the execution stopped.</p>
    pub fn stop_date(&self) -> &::aws_smithy_types::DateTime {
        &self.stop_date
    }
    /// <p>The current status of the execution.</p>
    pub fn status(&self) -> &crate::types::SyncExecutionStatus {
        &self.status
    }
    /// <p>The error code of the failure.</p>
    pub fn error(&self) -> ::std::option::Option<&str> {
        self.error.as_deref()
    }
    /// <p>A more detailed explanation of the cause of the failure.</p>
    pub fn cause(&self) -> ::std::option::Option<&str> {
        self.cause.as_deref()
    }
    /// <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
    pub fn input(&self) -> ::std::option::Option<&str> {
        self.input.as_deref()
    }
    /// <p>Provides details about execution input or output.</p>
    pub fn input_details(&self) -> ::std::option::Option<&crate::types::CloudWatchEventsExecutionDataDetails> {
        self.input_details.as_ref()
    }
    /// <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p><note>
    /// <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p>
    /// </note>
    pub fn output(&self) -> ::std::option::Option<&str> {
        self.output.as_deref()
    }
    /// <p>Provides details about execution input or output.</p>
    pub fn output_details(&self) -> ::std::option::Option<&crate::types::CloudWatchEventsExecutionDataDetails> {
        self.output_details.as_ref()
    }
    /// <p>The X-Ray trace header that was passed to the execution.</p><note>
    /// <p>For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.</p>
    /// </note>
    pub fn trace_header(&self) -> ::std::option::Option<&str> {
        self.trace_header.as_deref()
    }
    /// <p>An object that describes workflow billing details, including billed duration and memory use.</p>
    pub fn billing_details(&self) -> ::std::option::Option<&crate::types::BillingDetails> {
        self.billing_details.as_ref()
    }
}
impl ::std::fmt::Debug for StartSyncExecutionOutput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("StartSyncExecutionOutput");
        formatter.field("execution_arn", &self.execution_arn);
        formatter.field("state_machine_arn", &self.state_machine_arn);
        formatter.field("name", &self.name);
        formatter.field("start_date", &self.start_date);
        formatter.field("stop_date", &self.stop_date);
        formatter.field("status", &self.status);
        formatter.field("error", &"*** Sensitive Data Redacted ***");
        formatter.field("cause", &"*** Sensitive Data Redacted ***");
        formatter.field("input", &"*** Sensitive Data Redacted ***");
        formatter.field("input_details", &self.input_details);
        formatter.field("output", &"*** Sensitive Data Redacted ***");
        formatter.field("output_details", &self.output_details);
        formatter.field("trace_header", &self.trace_header);
        formatter.field("billing_details", &self.billing_details);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}
impl ::aws_types::request_id::RequestId for StartSyncExecutionOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl StartSyncExecutionOutput {
    /// Creates a new builder-style object to manufacture [`StartSyncExecutionOutput`](crate::operation::start_sync_execution::StartSyncExecutionOutput).
    pub fn builder() -> crate::operation::start_sync_execution::builders::StartSyncExecutionOutputBuilder {
        crate::operation::start_sync_execution::builders::StartSyncExecutionOutputBuilder::default()
    }
}

/// A builder for [`StartSyncExecutionOutput`](crate::operation::start_sync_execution::StartSyncExecutionOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct StartSyncExecutionOutputBuilder {
    pub(crate) execution_arn: ::std::option::Option<::std::string::String>,
    pub(crate) state_machine_arn: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) start_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) stop_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) status: ::std::option::Option<crate::types::SyncExecutionStatus>,
    pub(crate) error: ::std::option::Option<::std::string::String>,
    pub(crate) cause: ::std::option::Option<::std::string::String>,
    pub(crate) input: ::std::option::Option<::std::string::String>,
    pub(crate) input_details: ::std::option::Option<crate::types::CloudWatchEventsExecutionDataDetails>,
    pub(crate) output: ::std::option::Option<::std::string::String>,
    pub(crate) output_details: ::std::option::Option<crate::types::CloudWatchEventsExecutionDataDetails>,
    pub(crate) trace_header: ::std::option::Option<::std::string::String>,
    pub(crate) billing_details: ::std::option::Option<crate::types::BillingDetails>,
    _request_id: Option<String>,
}
impl StartSyncExecutionOutputBuilder {
    /// <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
    /// This field is required.
    pub fn execution_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.execution_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
    pub fn set_execution_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.execution_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
    pub fn get_execution_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.execution_arn
    }
    /// <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
    pub fn state_machine_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.state_machine_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
    pub fn set_state_machine_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.state_machine_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
    pub fn get_state_machine_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.state_machine_arn
    }
    /// <p>The name of the execution.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the execution.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the execution.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The date the execution is started.</p>
    /// This field is required.
    pub fn start_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.start_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date the execution is started.</p>
    pub fn set_start_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.start_date = input;
        self
    }
    /// <p>The date the execution is started.</p>
    pub fn get_start_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.start_date
    }
    /// <p>If the execution has already ended, the date the execution stopped.</p>
    /// This field is required.
    pub fn stop_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.stop_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>If the execution has already ended, the date the execution stopped.</p>
    pub fn set_stop_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.stop_date = input;
        self
    }
    /// <p>If the execution has already ended, the date the execution stopped.</p>
    pub fn get_stop_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.stop_date
    }
    /// <p>The current status of the execution.</p>
    /// This field is required.
    pub fn status(mut self, input: crate::types::SyncExecutionStatus) -> Self {
        self.status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the execution.</p>
    pub fn set_status(mut self, input: ::std::option::Option<crate::types::SyncExecutionStatus>) -> Self {
        self.status = input;
        self
    }
    /// <p>The current status of the execution.</p>
    pub fn get_status(&self) -> &::std::option::Option<crate::types::SyncExecutionStatus> {
        &self.status
    }
    /// <p>The error code of the failure.</p>
    pub fn error(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.error = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The error code of the failure.</p>
    pub fn set_error(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.error = input;
        self
    }
    /// <p>The error code of the failure.</p>
    pub fn get_error(&self) -> &::std::option::Option<::std::string::String> {
        &self.error
    }
    /// <p>A more detailed explanation of the cause of the failure.</p>
    pub fn cause(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.cause = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A more detailed explanation of the cause of the failure.</p>
    pub fn set_cause(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.cause = input;
        self
    }
    /// <p>A more detailed explanation of the cause of the failure.</p>
    pub fn get_cause(&self) -> &::std::option::Option<::std::string::String> {
        &self.cause
    }
    /// <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
    pub fn input(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.input = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
    pub fn set_input(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.input = input;
        self
    }
    /// <p>The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
    pub fn get_input(&self) -> &::std::option::Option<::std::string::String> {
        &self.input
    }
    /// <p>Provides details about execution input or output.</p>
    pub fn input_details(mut self, input: crate::types::CloudWatchEventsExecutionDataDetails) -> Self {
        self.input_details = ::std::option::Option::Some(input);
        self
    }
    /// <p>Provides details about execution input or output.</p>
    pub fn set_input_details(mut self, input: ::std::option::Option<crate::types::CloudWatchEventsExecutionDataDetails>) -> Self {
        self.input_details = input;
        self
    }
    /// <p>Provides details about execution input or output.</p>
    pub fn get_input_details(&self) -> &::std::option::Option<crate::types::CloudWatchEventsExecutionDataDetails> {
        &self.input_details
    }
    /// <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p><note>
    /// <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p>
    /// </note>
    pub fn output(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.output = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p><note>
    /// <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p>
    /// </note>
    pub fn set_output(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.output = input;
        self
    }
    /// <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p><note>
    /// <p>This field is set only if the execution succeeds. If the execution fails, this field is null.</p>
    /// </note>
    pub fn get_output(&self) -> &::std::option::Option<::std::string::String> {
        &self.output
    }
    /// <p>Provides details about execution input or output.</p>
    pub fn output_details(mut self, input: crate::types::CloudWatchEventsExecutionDataDetails) -> Self {
        self.output_details = ::std::option::Option::Some(input);
        self
    }
    /// <p>Provides details about execution input or output.</p>
    pub fn set_output_details(mut self, input: ::std::option::Option<crate::types::CloudWatchEventsExecutionDataDetails>) -> Self {
        self.output_details = input;
        self
    }
    /// <p>Provides details about execution input or output.</p>
    pub fn get_output_details(&self) -> &::std::option::Option<crate::types::CloudWatchEventsExecutionDataDetails> {
        &self.output_details
    }
    /// <p>The X-Ray trace header that was passed to the execution.</p><note>
    /// <p>For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.</p>
    /// </note>
    pub fn trace_header(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.trace_header = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The X-Ray trace header that was passed to the execution.</p><note>
    /// <p>For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.</p>
    /// </note>
    pub fn set_trace_header(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.trace_header = input;
        self
    }
    /// <p>The X-Ray trace header that was passed to the execution.</p><note>
    /// <p>For X-Ray traces, all Amazon Web Services services use the <code>X-Amzn-Trace-Id</code> header from the HTTP request. Using the header is the preferred mechanism to identify a trace. <code>StartExecution</code> and <code>StartSyncExecution</code> API operations can also use <code>traceHeader</code> from the body of the request payload. If <b>both</b> sources are provided, Step Functions will use the <b>header value</b> (preferred) over the value in the request body.</p>
    /// </note>
    pub fn get_trace_header(&self) -> &::std::option::Option<::std::string::String> {
        &self.trace_header
    }
    /// <p>An object that describes workflow billing details, including billed duration and memory use.</p>
    pub fn billing_details(mut self, input: crate::types::BillingDetails) -> Self {
        self.billing_details = ::std::option::Option::Some(input);
        self
    }
    /// <p>An object that describes workflow billing details, including billed duration and memory use.</p>
    pub fn set_billing_details(mut self, input: ::std::option::Option<crate::types::BillingDetails>) -> Self {
        self.billing_details = input;
        self
    }
    /// <p>An object that describes workflow billing details, including billed duration and memory use.</p>
    pub fn get_billing_details(&self) -> &::std::option::Option<crate::types::BillingDetails> {
        &self.billing_details
    }
    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 [`StartSyncExecutionOutput`](crate::operation::start_sync_execution::StartSyncExecutionOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`execution_arn`](crate::operation::start_sync_execution::builders::StartSyncExecutionOutputBuilder::execution_arn)
    /// - [`start_date`](crate::operation::start_sync_execution::builders::StartSyncExecutionOutputBuilder::start_date)
    /// - [`stop_date`](crate::operation::start_sync_execution::builders::StartSyncExecutionOutputBuilder::stop_date)
    /// - [`status`](crate::operation::start_sync_execution::builders::StartSyncExecutionOutputBuilder::status)
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::start_sync_execution::StartSyncExecutionOutput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::start_sync_execution::StartSyncExecutionOutput {
            execution_arn: self.execution_arn.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "execution_arn",
                    "execution_arn was not specified but it is required when building StartSyncExecutionOutput",
                )
            })?,
            state_machine_arn: self.state_machine_arn,
            name: self.name,
            start_date: self.start_date.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "start_date",
                    "start_date was not specified but it is required when building StartSyncExecutionOutput",
                )
            })?,
            stop_date: self.stop_date.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "stop_date",
                    "stop_date was not specified but it is required when building StartSyncExecutionOutput",
                )
            })?,
            status: self.status.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "status",
                    "status was not specified but it is required when building StartSyncExecutionOutput",
                )
            })?,
            error: self.error,
            cause: self.cause,
            input: self.input,
            input_details: self.input_details,
            output: self.output,
            output_details: self.output_details,
            trace_header: self.trace_header,
            billing_details: self.billing_details,
            _request_id: self._request_id,
        })
    }
}
impl ::std::fmt::Debug for StartSyncExecutionOutputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("StartSyncExecutionOutputBuilder");
        formatter.field("execution_arn", &self.execution_arn);
        formatter.field("state_machine_arn", &self.state_machine_arn);
        formatter.field("name", &self.name);
        formatter.field("start_date", &self.start_date);
        formatter.field("stop_date", &self.stop_date);
        formatter.field("status", &self.status);
        formatter.field("error", &"*** Sensitive Data Redacted ***");
        formatter.field("cause", &"*** Sensitive Data Redacted ***");
        formatter.field("input", &"*** Sensitive Data Redacted ***");
        formatter.field("input_details", &self.input_details);
        formatter.field("output", &"*** Sensitive Data Redacted ***");
        formatter.field("output_details", &self.output_details);
        formatter.field("trace_header", &self.trace_header);
        formatter.field("billing_details", &self.billing_details);
        formatter.field("_request_id", &self._request_id);
        formatter.finish()
    }
}