aws_sdk_personalize/operation/create_recommender/
_create_recommender_input.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 CreateRecommenderInput {
6    /// <p>The name of the recommender.</p>
7    pub name: ::std::option::Option<::std::string::String>,
8    /// <p>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</p>
9    pub dataset_group_arn: ::std::option::Option<::std::string::String>,
10    /// <p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.</p>
11    pub recipe_arn: ::std::option::Option<::std::string::String>,
12    /// <p>The configuration details of the recommender.</p>
13    pub recommender_config: ::std::option::Option<crate::types::RecommenderConfig>,
14    /// <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the recommender.</p>
15    pub tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
16}
17impl CreateRecommenderInput {
18    /// <p>The name of the recommender.</p>
19    pub fn name(&self) -> ::std::option::Option<&str> {
20        self.name.as_deref()
21    }
22    /// <p>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</p>
23    pub fn dataset_group_arn(&self) -> ::std::option::Option<&str> {
24        self.dataset_group_arn.as_deref()
25    }
26    /// <p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.</p>
27    pub fn recipe_arn(&self) -> ::std::option::Option<&str> {
28        self.recipe_arn.as_deref()
29    }
30    /// <p>The configuration details of the recommender.</p>
31    pub fn recommender_config(&self) -> ::std::option::Option<&crate::types::RecommenderConfig> {
32        self.recommender_config.as_ref()
33    }
34    /// <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the recommender.</p>
35    ///
36    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.tags.is_none()`.
37    pub fn tags(&self) -> &[crate::types::Tag] {
38        self.tags.as_deref().unwrap_or_default()
39    }
40}
41impl CreateRecommenderInput {
42    /// Creates a new builder-style object to manufacture [`CreateRecommenderInput`](crate::operation::create_recommender::CreateRecommenderInput).
43    pub fn builder() -> crate::operation::create_recommender::builders::CreateRecommenderInputBuilder {
44        crate::operation::create_recommender::builders::CreateRecommenderInputBuilder::default()
45    }
46}
47
48/// A builder for [`CreateRecommenderInput`](crate::operation::create_recommender::CreateRecommenderInput).
49#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
50#[non_exhaustive]
51pub struct CreateRecommenderInputBuilder {
52    pub(crate) name: ::std::option::Option<::std::string::String>,
53    pub(crate) dataset_group_arn: ::std::option::Option<::std::string::String>,
54    pub(crate) recipe_arn: ::std::option::Option<::std::string::String>,
55    pub(crate) recommender_config: ::std::option::Option<crate::types::RecommenderConfig>,
56    pub(crate) tags: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>,
57}
58impl CreateRecommenderInputBuilder {
59    /// <p>The name of the recommender.</p>
60    /// This field is required.
61    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
62        self.name = ::std::option::Option::Some(input.into());
63        self
64    }
65    /// <p>The name of the recommender.</p>
66    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
67        self.name = input;
68        self
69    }
70    /// <p>The name of the recommender.</p>
71    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
72        &self.name
73    }
74    /// <p>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</p>
75    /// This field is required.
76    pub fn dataset_group_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
77        self.dataset_group_arn = ::std::option::Option::Some(input.into());
78        self
79    }
80    /// <p>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</p>
81    pub fn set_dataset_group_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
82        self.dataset_group_arn = input;
83        self
84    }
85    /// <p>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</p>
86    pub fn get_dataset_group_arn(&self) -> &::std::option::Option<::std::string::String> {
87        &self.dataset_group_arn
88    }
89    /// <p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.</p>
90    /// This field is required.
91    pub fn recipe_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
92        self.recipe_arn = ::std::option::Option::Some(input.into());
93        self
94    }
95    /// <p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.</p>
96    pub fn set_recipe_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
97        self.recipe_arn = input;
98        self
99    }
100    /// <p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.</p>
101    pub fn get_recipe_arn(&self) -> &::std::option::Option<::std::string::String> {
102        &self.recipe_arn
103    }
104    /// <p>The configuration details of the recommender.</p>
105    pub fn recommender_config(mut self, input: crate::types::RecommenderConfig) -> Self {
106        self.recommender_config = ::std::option::Option::Some(input);
107        self
108    }
109    /// <p>The configuration details of the recommender.</p>
110    pub fn set_recommender_config(mut self, input: ::std::option::Option<crate::types::RecommenderConfig>) -> Self {
111        self.recommender_config = input;
112        self
113    }
114    /// <p>The configuration details of the recommender.</p>
115    pub fn get_recommender_config(&self) -> &::std::option::Option<crate::types::RecommenderConfig> {
116        &self.recommender_config
117    }
118    /// Appends an item to `tags`.
119    ///
120    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
121    ///
122    /// <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the recommender.</p>
123    pub fn tags(mut self, input: crate::types::Tag) -> Self {
124        let mut v = self.tags.unwrap_or_default();
125        v.push(input);
126        self.tags = ::std::option::Option::Some(v);
127        self
128    }
129    /// <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the recommender.</p>
130    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
131        self.tags = input;
132        self
133    }
134    /// <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the recommender.</p>
135    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
136        &self.tags
137    }
138    /// Consumes the builder and constructs a [`CreateRecommenderInput`](crate::operation::create_recommender::CreateRecommenderInput).
139    pub fn build(
140        self,
141    ) -> ::std::result::Result<crate::operation::create_recommender::CreateRecommenderInput, ::aws_smithy_types::error::operation::BuildError> {
142        ::std::result::Result::Ok(crate::operation::create_recommender::CreateRecommenderInput {
143            name: self.name,
144            dataset_group_arn: self.dataset_group_arn,
145            recipe_arn: self.recipe_arn,
146            recommender_config: self.recommender_config,
147            tags: self.tags,
148        })
149    }
150}
aws_sdk_personalize/operation/create_recommender/_create_recommender_input.rs

aws_sdk_personalize/operation/create_recommender/
_create_recommender_input.rs
