aws-sdk-cloudsearch 1.98.0

AWS SDK for Amazon CloudSearch
Documentation 
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

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <code>FuzzyMatching</code>, <code>SortExpression</code>.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Suggester {
    /// <p>Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).</p>
    pub suggester_name: ::std::string::String,
    /// <p>Options for a search suggester.</p>
    pub document_suggester_options: ::std::option::Option<crate::types::DocumentSuggesterOptions>,
}
impl Suggester {
    /// <p>Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).</p>
    pub fn suggester_name(&self) -> &str {
        use std::ops::Deref;
        self.suggester_name.deref()
    }
    /// <p>Options for a search suggester.</p>
    pub fn document_suggester_options(&self) -> ::std::option::Option<&crate::types::DocumentSuggesterOptions> {
        self.document_suggester_options.as_ref()
    }
}
impl Suggester {
    /// Creates a new builder-style object to manufacture [`Suggester`](crate::types::Suggester).
    pub fn builder() -> crate::types::builders::SuggesterBuilder {
        crate::types::builders::SuggesterBuilder::default()
    }
}

/// A builder for [`Suggester`](crate::types::Suggester).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SuggesterBuilder {
    pub(crate) suggester_name: ::std::option::Option<::std::string::String>,
    pub(crate) document_suggester_options: ::std::option::Option<crate::types::DocumentSuggesterOptions>,
}
impl SuggesterBuilder {
    /// <p>Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).</p>
    /// This field is required.
    pub fn suggester_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.suggester_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).</p>
    pub fn set_suggester_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.suggester_name = input;
        self
    }
    /// <p>Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).</p>
    pub fn get_suggester_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.suggester_name
    }
    /// <p>Options for a search suggester.</p>
    /// This field is required.
    pub fn document_suggester_options(mut self, input: crate::types::DocumentSuggesterOptions) -> Self {
        self.document_suggester_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Options for a search suggester.</p>
    pub fn set_document_suggester_options(mut self, input: ::std::option::Option<crate::types::DocumentSuggesterOptions>) -> Self {
        self.document_suggester_options = input;
        self
    }
    /// <p>Options for a search suggester.</p>
    pub fn get_document_suggester_options(&self) -> &::std::option::Option<crate::types::DocumentSuggesterOptions> {
        &self.document_suggester_options
    }
    /// Consumes the builder and constructs a [`Suggester`](crate::types::Suggester).
    /// This method will fail if any of the following fields are not set:
    /// - [`suggester_name`](crate::types::builders::SuggesterBuilder::suggester_name)
    pub fn build(self) -> ::std::result::Result<crate::types::Suggester, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::types::Suggester {
            suggester_name: self.suggester_name.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "suggester_name",
                    "suggester_name was not specified but it is required when building Suggester",
                )
            })?,
            document_suggester_options: self.document_suggester_options,
        })
    }
}