aws-sdk-personalizeruntime 1.4.0

AWS SDK for Amazon Personalize Runtime
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96

// 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 GetPersonalizedRankingOutput {
    /// <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
    pub personalized_ranking: ::std::option::Option<::std::vec::Vec<crate::types::PredictedItem>>,
    /// <p>The ID of the recommendation.</p>
    pub recommendation_id: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetPersonalizedRankingOutput {
    /// <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.personalized_ranking.is_none()`.
    pub fn personalized_ranking(&self) -> &[crate::types::PredictedItem] {
        self.personalized_ranking.as_deref().unwrap_or_default()
    }
    /// <p>The ID of the recommendation.</p>
    pub fn recommendation_id(&self) -> ::std::option::Option<&str> {
        self.recommendation_id.as_deref()
    }
}
impl ::aws_types::request_id::RequestId for GetPersonalizedRankingOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl GetPersonalizedRankingOutput {
    /// Creates a new builder-style object to manufacture [`GetPersonalizedRankingOutput`](crate::operation::get_personalized_ranking::GetPersonalizedRankingOutput).
    pub fn builder() -> crate::operation::get_personalized_ranking::builders::GetPersonalizedRankingOutputBuilder {
        crate::operation::get_personalized_ranking::builders::GetPersonalizedRankingOutputBuilder::default()
    }
}

/// A builder for [`GetPersonalizedRankingOutput`](crate::operation::get_personalized_ranking::GetPersonalizedRankingOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct GetPersonalizedRankingOutputBuilder {
    pub(crate) personalized_ranking: ::std::option::Option<::std::vec::Vec<crate::types::PredictedItem>>,
    pub(crate) recommendation_id: ::std::option::Option<::std::string::String>,
    _request_id: Option<String>,
}
impl GetPersonalizedRankingOutputBuilder {
    /// Appends an item to `personalized_ranking`.
    ///
    /// To override the contents of this collection use [`set_personalized_ranking`](Self::set_personalized_ranking).
    ///
    /// <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
    pub fn personalized_ranking(mut self, input: crate::types::PredictedItem) -> Self {
        let mut v = self.personalized_ranking.unwrap_or_default();
        v.push(input);
        self.personalized_ranking = ::std::option::Option::Some(v);
        self
    }
    /// <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
    pub fn set_personalized_ranking(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::PredictedItem>>) -> Self {
        self.personalized_ranking = input;
        self
    }
    /// <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
    pub fn get_personalized_ranking(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::PredictedItem>> {
        &self.personalized_ranking
    }
    /// <p>The ID of the recommendation.</p>
    pub fn recommendation_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.recommendation_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the recommendation.</p>
    pub fn set_recommendation_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.recommendation_id = input;
        self
    }
    /// <p>The ID of the recommendation.</p>
    pub fn get_recommendation_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.recommendation_id
    }
    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 [`GetPersonalizedRankingOutput`](crate::operation::get_personalized_ranking::GetPersonalizedRankingOutput).
    pub fn build(self) -> crate::operation::get_personalized_ranking::GetPersonalizedRankingOutput {
        crate::operation::get_personalized_ranking::GetPersonalizedRankingOutput {
            personalized_ranking: self.personalized_ranking,
            recommendation_id: self.recommendation_id,
            _request_id: self._request_id,
        }
    }
}