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, ::std::fmt::Debug)]
pub struct GetScreenDataOutput {
    /// <p>A map of all the rows on the screen keyed by block name.</p>
    pub results: ::std::collections::HashMap<::std::string::String, crate::types::ResultSet>,
    /// <p>Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.</p>
    pub workbook_cursor: i64,
    /// <p>Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetScreenDataOutput {
    /// <p>A map of all the rows on the screen keyed by block name.</p>
    pub fn results(&self) -> &::std::collections::HashMap<::std::string::String, crate::types::ResultSet> {
        &self.results
    }
    /// <p>Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.</p>
    pub fn workbook_cursor(&self) -> i64 {
        self.workbook_cursor
    }
    /// <p>Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
}
impl ::aws_types::request_id::RequestId for GetScreenDataOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetScreenDataOutput {
    /// Creates a new builder-style object to manufacture [`GetScreenDataOutput`](crate::operation::get_screen_data::GetScreenDataOutput).
    pub fn builder() -> crate::operation::get_screen_data::builders::GetScreenDataOutputBuilder {
        crate::operation::get_screen_data::builders::GetScreenDataOutputBuilder::default()
    }
}

/// A builder for [`GetScreenDataOutput`](crate::operation::get_screen_data::GetScreenDataOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct GetScreenDataOutputBuilder {
    pub(crate) results: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ResultSet>>,
    pub(crate) workbook_cursor: ::std::option::Option<i64>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetScreenDataOutputBuilder {
    /// Adds a key-value pair to `results`.
    ///
    /// To override the contents of this collection use [`set_results`](Self::set_results).
    ///
    /// <p>A map of all the rows on the screen keyed by block name.</p>
    pub fn results(mut self, k: impl ::std::convert::Into<::std::string::String>, v: crate::types::ResultSet) -> Self {
        let mut hash_map = self.results.unwrap_or_default();
        hash_map.insert(k.into(), v);
        self.results = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>A map of all the rows on the screen keyed by block name.</p>
    pub fn set_results(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ResultSet>>) -> Self {
        self.results = input;
        self
    }
    /// <p>A map of all the rows on the screen keyed by block name.</p>
    pub fn get_results(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, crate::types::ResultSet>> {
        &self.results
    }
    /// <p>Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.</p>
    /// This field is required.
    pub fn workbook_cursor(mut self, input: i64) -> Self {
        self.workbook_cursor = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.</p>
    pub fn set_workbook_cursor(mut self, input: ::std::option::Option<i64>) -> Self {
        self.workbook_cursor = input;
        self
    }
    /// <p>Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.</p>
    pub fn get_workbook_cursor(&self) -> &::std::option::Option<i64> {
        &self.workbook_cursor
    }
    /// <p>Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.</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>Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    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 [`GetScreenDataOutput`](crate::operation::get_screen_data::GetScreenDataOutput).
    /// This method will fail if any of the following fields are not set:
    /// - [`results`](crate::operation::get_screen_data::builders::GetScreenDataOutputBuilder::results)
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::get_screen_data::GetScreenDataOutput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::get_screen_data::GetScreenDataOutput {
            results: self.results.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "results",
                    "results was not specified but it is required when building GetScreenDataOutput",
                )
            })?,
            workbook_cursor: self.workbook_cursor.unwrap_or_default(),
            next_token: self.next_token,
            _request_id: self._request_id,
        })
    }
}