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
// 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 SearchIndexInput {
/// <p>The search index name.</p>
pub index_name: ::std::option::Option<::std::string::String>,
/// <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p>
pub query_string: ::std::option::Option<::std::string::String>,
/// <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
pub next_token: ::std::option::Option<::std::string::String>,
/// <p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p>
pub max_results: ::std::option::Option<i32>,
/// <p>The query version.</p>
pub query_version: ::std::option::Option<::std::string::String>,
}
impl SearchIndexInput {
/// <p>The search index name.</p>
pub fn index_name(&self) -> ::std::option::Option<&str> {
self.index_name.as_deref()
}
/// <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p>
pub fn query_string(&self) -> ::std::option::Option<&str> {
self.query_string.as_deref()
}
/// <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
pub fn next_token(&self) -> ::std::option::Option<&str> {
self.next_token.as_deref()
}
/// <p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p>
pub fn max_results(&self) -> ::std::option::Option<i32> {
self.max_results
}
/// <p>The query version.</p>
pub fn query_version(&self) -> ::std::option::Option<&str> {
self.query_version.as_deref()
}
}
impl SearchIndexInput {
/// Creates a new builder-style object to manufacture [`SearchIndexInput`](crate::operation::search_index::SearchIndexInput).
pub fn builder() -> crate::operation::search_index::builders::SearchIndexInputBuilder {
crate::operation::search_index::builders::SearchIndexInputBuilder::default()
}
}
/// A builder for [`SearchIndexInput`](crate::operation::search_index::SearchIndexInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct SearchIndexInputBuilder {
pub(crate) index_name: ::std::option::Option<::std::string::String>,
pub(crate) query_string: ::std::option::Option<::std::string::String>,
pub(crate) next_token: ::std::option::Option<::std::string::String>,
pub(crate) max_results: ::std::option::Option<i32>,
pub(crate) query_version: ::std::option::Option<::std::string::String>,
}
impl SearchIndexInputBuilder {
/// <p>The search 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 search 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 search index name.</p>
pub fn get_index_name(&self) -> &::std::option::Option<::std::string::String> {
&self.index_name
}
/// <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p>
/// This field is required.
pub fn query_string(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.query_string = ::std::option::Option::Some(input.into());
self
}
/// <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p>
pub fn set_query_string(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.query_string = input;
self
}
/// <p>The search query string. For more information about the search query syntax, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/query-syntax.html">Query syntax</a>.</p>
pub fn get_query_string(&self) -> &::std::option::Option<::std::string::String> {
&self.query_string
}
/// <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</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>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.next_token = input;
self
}
/// <p>The token used to get the next set of results, or <code>null</code> if there are no additional results.</p>
pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
&self.next_token
}
/// <p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p>
pub fn max_results(mut self, input: i32) -> Self {
self.max_results = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p>
pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_results = input;
self
}
/// <p>The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_SearchIndex.html#iot-SearchIndex-request-nextToken"> <code>nextToken</code> </a> to retrieve the next set of results until <code>nextToken</code> returns <code>NULL</code>.</p>
pub fn get_max_results(&self) -> &::std::option::Option<i32> {
&self.max_results
}
/// <p>The query version.</p>
pub fn query_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.query_version = ::std::option::Option::Some(input.into());
self
}
/// <p>The query version.</p>
pub fn set_query_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.query_version = input;
self
}
/// <p>The query version.</p>
pub fn get_query_version(&self) -> &::std::option::Option<::std::string::String> {
&self.query_version
}
/// Consumes the builder and constructs a [`SearchIndexInput`](crate::operation::search_index::SearchIndexInput).
pub fn build(self) -> ::std::result::Result<crate::operation::search_index::SearchIndexInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::search_index::SearchIndexInput {
index_name: self.index_name,
query_string: self.query_string,
next_token: self.next_token,
max_results: self.max_results,
query_version: self.query_version,
})
}
}