aws_sdk_iot/operation/describe_index/
_describe_index_output.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeIndexOutput {
6    /// <p>The index name.</p>
7    pub index_name: ::std::option::Option<::std::string::String>,
8    /// <p>The index status.</p>
9    pub index_status: ::std::option::Option<crate::types::IndexStatus>,
10    /// <p>Contains a value that specifies the type of indexing performed. Valid values are:</p>
11    /// <ul>
12    /// <li>
13    /// <p>REGISTRY – Your thing index contains only registry data.</p></li>
14    /// <li>
15    /// <p>REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.</p></li>
16    /// <li>
17    /// <p>REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.</p></li>
18    /// <li>
19    /// <p>REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.</p></li>
20    /// <li>
21    /// <p>MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html">GetIndexingConfiguration</a>.</p></li>
22    /// </ul>
23    pub schema: ::std::option::Option<::std::string::String>,
24    _request_id: Option<String>,
25}
26impl DescribeIndexOutput {
27    /// <p>The index name.</p>
28    pub fn index_name(&self) -> ::std::option::Option<&str> {
29        self.index_name.as_deref()
30    }
31    /// <p>The index status.</p>
32    pub fn index_status(&self) -> ::std::option::Option<&crate::types::IndexStatus> {
33        self.index_status.as_ref()
34    }
35    /// <p>Contains a value that specifies the type of indexing performed. Valid values are:</p>
36    /// <ul>
37    /// <li>
38    /// <p>REGISTRY – Your thing index contains only registry data.</p></li>
39    /// <li>
40    /// <p>REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.</p></li>
41    /// <li>
42    /// <p>REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.</p></li>
43    /// <li>
44    /// <p>REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.</p></li>
45    /// <li>
46    /// <p>MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html">GetIndexingConfiguration</a>.</p></li>
47    /// </ul>
48    pub fn schema(&self) -> ::std::option::Option<&str> {
49        self.schema.as_deref()
50    }
51}
52impl ::aws_types::request_id::RequestId for DescribeIndexOutput {
53    fn request_id(&self) -> Option<&str> {
54        self._request_id.as_deref()
55    }
56}
57impl DescribeIndexOutput {
58    /// Creates a new builder-style object to manufacture [`DescribeIndexOutput`](crate::operation::describe_index::DescribeIndexOutput).
59    pub fn builder() -> crate::operation::describe_index::builders::DescribeIndexOutputBuilder {
60        crate::operation::describe_index::builders::DescribeIndexOutputBuilder::default()
61    }
62}
63
64/// A builder for [`DescribeIndexOutput`](crate::operation::describe_index::DescribeIndexOutput).
65#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
66#[non_exhaustive]
67pub struct DescribeIndexOutputBuilder {
68    pub(crate) index_name: ::std::option::Option<::std::string::String>,
69    pub(crate) index_status: ::std::option::Option<crate::types::IndexStatus>,
70    pub(crate) schema: ::std::option::Option<::std::string::String>,
71    _request_id: Option<String>,
72}
73impl DescribeIndexOutputBuilder {
74    /// <p>The index name.</p>
75    pub fn index_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
76        self.index_name = ::std::option::Option::Some(input.into());
77        self
78    }
79    /// <p>The index name.</p>
80    pub fn set_index_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
81        self.index_name = input;
82        self
83    }
84    /// <p>The index name.</p>
85    pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
86        &self.index_name
87    }
88    /// <p>The index status.</p>
89    pub fn index_status(mut self, input: crate::types::IndexStatus) -> Self {
90        self.index_status = ::std::option::Option::Some(input);
91        self
92    }
93    /// <p>The index status.</p>
94    pub fn set_index_status(mut self, input: ::std::option::Option<crate::types::IndexStatus>) -> Self {
95        self.index_status = input;
96        self
97    }
98    /// <p>The index status.</p>
99    pub fn get_index_status(&self) -> &::std::option::Option<crate::types::IndexStatus> {
100        &self.index_status
101    }
102    /// <p>Contains a value that specifies the type of indexing performed. Valid values are:</p>
103    /// <ul>
104    /// <li>
105    /// <p>REGISTRY – Your thing index contains only registry data.</p></li>
106    /// <li>
107    /// <p>REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.</p></li>
108    /// <li>
109    /// <p>REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.</p></li>
110    /// <li>
111    /// <p>REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.</p></li>
112    /// <li>
113    /// <p>MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html">GetIndexingConfiguration</a>.</p></li>
114    /// </ul>
115    pub fn schema(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
116        self.schema = ::std::option::Option::Some(input.into());
117        self
118    }
119    /// <p>Contains a value that specifies the type of indexing performed. Valid values are:</p>
120    /// <ul>
121    /// <li>
122    /// <p>REGISTRY – Your thing index contains only registry data.</p></li>
123    /// <li>
124    /// <p>REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.</p></li>
125    /// <li>
126    /// <p>REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.</p></li>
127    /// <li>
128    /// <p>REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.</p></li>
129    /// <li>
130    /// <p>MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html">GetIndexingConfiguration</a>.</p></li>
131    /// </ul>
132    pub fn set_schema(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.schema = input;
134        self
135    }
136    /// <p>Contains a value that specifies the type of indexing performed. Valid values are:</p>
137    /// <ul>
138    /// <li>
139    /// <p>REGISTRY – Your thing index contains only registry data.</p></li>
140    /// <li>
141    /// <p>REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.</p></li>
142    /// <li>
143    /// <p>REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.</p></li>
144    /// <li>
145    /// <p>REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.</p></li>
146    /// <li>
147    /// <p>MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html">GetIndexingConfiguration</a>.</p></li>
148    /// </ul>
149    pub fn get_schema(&self) -> &::std::option::Option<::std::string::String> {
150        &self.schema
151    }
152    pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
153        self._request_id = Some(request_id.into());
154        self
155    }
156
157    pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
158        self._request_id = request_id;
159        self
160    }
161    /// Consumes the builder and constructs a [`DescribeIndexOutput`](crate::operation::describe_index::DescribeIndexOutput).
162    pub fn build(self) -> crate::operation::describe_index::DescribeIndexOutput {
163        crate::operation::describe_index::DescribeIndexOutput {
164            index_name: self.index_name,
165            index_status: self.index_status,
166            schema: self.schema,
167            _request_id: self._request_id,
168        }
169    }
170}
aws_sdk_iot/operation/describe_index/_describe_index_output.rs

aws_sdk_iot/operation/describe_index/
_describe_index_output.rs
