aws-sdk-honeycode 1.28.0

AWS SDK for Amazon Honeycode
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)]
pub struct InvokeScreenAutomationInput {
    /// <p>The ID of the workbook that contains the screen automation.</p>
    pub workbook_id: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the app that contains the screen automation.</p>
    pub app_id: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the screen that contains the screen automation.</p>
    pub screen_id: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the automation action to be performed.</p>
    pub screen_automation_id: ::std::option::Option<::std::string::String>,
    /// <p>Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.</p>
    pub variables: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::VariableValue>>,
    /// <p>The row ID for the automation if the automation is defined inside a block with source or list.</p>
    pub row_id: ::std::option::Option<::std::string::String>,
    /// <p>The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.</p>
    /// <p>Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.</p>
    pub client_request_token: ::std::option::Option<::std::string::String>,
}
impl InvokeScreenAutomationInput {
    /// <p>The ID of the workbook that contains the screen automation.</p>
    pub fn workbook_id(&self) -> ::std::option::Option<&str> {
        self.workbook_id.as_deref()
    }
    /// <p>The ID of the app that contains the screen automation.</p>
    pub fn app_id(&self) -> ::std::option::Option<&str> {
        self.app_id.as_deref()
    }
    /// <p>The ID of the screen that contains the screen automation.</p>
    pub fn screen_id(&self) -> ::std::option::Option<&str> {
        self.screen_id.as_deref()
    }
    /// <p>The ID of the automation action to be performed.</p>
    pub fn screen_automation_id(&self) -> ::std::option::Option<&str> {
        self.screen_automation_id.as_deref()
    }
    /// <p>Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.</p>
    pub fn variables(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, crate::types::VariableValue>> {
        self.variables.as_ref()
    }
    /// <p>The row ID for the automation if the automation is defined inside a block with source or list.</p>
    pub fn row_id(&self) -> ::std::option::Option<&str> {
        self.row_id.as_deref()
    }
    /// <p>The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.</p>
    /// <p>Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.</p>
    pub fn client_request_token(&self) -> ::std::option::Option<&str> {
        self.client_request_token.as_deref()
    }
}
impl ::std::fmt::Debug for InvokeScreenAutomationInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("InvokeScreenAutomationInput");
        formatter.field("workbook_id", &self.workbook_id);
        formatter.field("app_id", &self.app_id);
        formatter.field("screen_id", &self.screen_id);
        formatter.field("screen_automation_id", &self.screen_automation_id);
        formatter.field("variables", &"*** Sensitive Data Redacted ***");
        formatter.field("row_id", &self.row_id);
        formatter.field("client_request_token", &self.client_request_token);
        formatter.finish()
    }
}
impl InvokeScreenAutomationInput {
    /// Creates a new builder-style object to manufacture [`InvokeScreenAutomationInput`](crate::operation::invoke_screen_automation::InvokeScreenAutomationInput).
    pub fn builder() -> crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationInputBuilder {
        crate::operation::invoke_screen_automation::builders::InvokeScreenAutomationInputBuilder::default()
    }
}

/// A builder for [`InvokeScreenAutomationInput`](crate::operation::invoke_screen_automation::InvokeScreenAutomationInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
pub struct InvokeScreenAutomationInputBuilder {
    pub(crate) workbook_id: ::std::option::Option<::std::string::String>,
    pub(crate) app_id: ::std::option::Option<::std::string::String>,
    pub(crate) screen_id: ::std::option::Option<::std::string::String>,
    pub(crate) screen_automation_id: ::std::option::Option<::std::string::String>,
    pub(crate) variables: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::VariableValue>>,
    pub(crate) row_id: ::std::option::Option<::std::string::String>,
    pub(crate) client_request_token: ::std::option::Option<::std::string::String>,
}
impl InvokeScreenAutomationInputBuilder {
    /// <p>The ID of the workbook that contains the screen automation.</p>
    /// This field is required.
    pub fn workbook_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.workbook_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the workbook that contains the screen automation.</p>
    pub fn set_workbook_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.workbook_id = input;
        self
    }
    /// <p>The ID of the workbook that contains the screen automation.</p>
    pub fn get_workbook_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.workbook_id
    }
    /// <p>The ID of the app that contains the screen automation.</p>
    /// This field is required.
    pub fn app_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.app_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the app that contains the screen automation.</p>
    pub fn set_app_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.app_id = input;
        self
    }
    /// <p>The ID of the app that contains the screen automation.</p>
    pub fn get_app_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.app_id
    }
    /// <p>The ID of the screen that contains the screen automation.</p>
    /// This field is required.
    pub fn screen_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.screen_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the screen that contains the screen automation.</p>
    pub fn set_screen_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.screen_id = input;
        self
    }
    /// <p>The ID of the screen that contains the screen automation.</p>
    pub fn get_screen_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.screen_id
    }
    /// <p>The ID of the automation action to be performed.</p>
    /// This field is required.
    pub fn screen_automation_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.screen_automation_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the automation action to be performed.</p>
    pub fn set_screen_automation_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.screen_automation_id = input;
        self
    }
    /// <p>The ID of the automation action to be performed.</p>
    pub fn get_screen_automation_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.screen_automation_id
    }
    /// Adds a key-value pair to `variables`.
    ///
    /// To override the contents of this collection use [`set_variables`](Self::set_variables).
    ///
    /// <p>Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.</p>
    pub fn variables(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::VariableValue) -> Self {
        let mut hash_map = self.variables.unwrap_or_default();
        hash_map.insert(k.into(), v);
        self.variables = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.</p>
    pub fn set_variables(
        mut self,
        input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::VariableValue>>,
    ) -> Self {
        self.variables = input;
        self
    }
    /// <p>Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.</p>
    pub fn get_variables(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::VariableValue>> {
        &self.variables
    }
    /// <p>The row ID for the automation if the automation is defined inside a block with source or list.</p>
    pub fn row_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.row_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The row ID for the automation if the automation is defined inside a block with source or list.</p>
    pub fn set_row_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.row_id = input;
        self
    }
    /// <p>The row ID for the automation if the automation is defined inside a block with source or list.</p>
    pub fn get_row_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.row_id
    }
    /// <p>The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.</p>
    /// <p>Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.</p>
    pub fn client_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_request_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.</p>
    /// <p>Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.</p>
    pub fn set_client_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_request_token = input;
        self
    }
    /// <p>The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.</p>
    /// <p>Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.</p>
    pub fn get_client_request_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_request_token
    }
    /// Consumes the builder and constructs a [`InvokeScreenAutomationInput`](crate::operation::invoke_screen_automation::InvokeScreenAutomationInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<
        crate::operation::invoke_screen_automation::InvokeScreenAutomationInput,
        ::aws_smithy_types::error::operation::BuildError,
    > {
        ::std::result::Result::Ok(crate::operation::invoke_screen_automation::InvokeScreenAutomationInput {
            workbook_id: self.workbook_id,
            app_id: self.app_id,
            screen_id: self.screen_id,
            screen_automation_id: self.screen_automation_id,
            variables: self.variables,
            row_id: self.row_id,
            client_request_token: self.client_request_token,
        })
    }
}
impl ::std::fmt::Debug for InvokeScreenAutomationInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("InvokeScreenAutomationInputBuilder");
        formatter.field("workbook_id", &self.workbook_id);
        formatter.field("app_id", &self.app_id);
        formatter.field("screen_id", &self.screen_id);
        formatter.field("screen_automation_id", &self.screen_automation_id);
        formatter.field("variables", &"*** Sensitive Data Redacted ***");
        formatter.field("row_id", &self.row_id);
        formatter.field("client_request_token", &self.client_request_token);
        formatter.finish()
    }
}