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