aws-sdk-workmail 1.96.0

AWS SDK for Amazon WorkMail
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
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198

// 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 DescribeGroupOutput {
    /// <p>The identifier of the described group.</p>
    pub group_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the described group.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The email of the described group.</p>
    pub email: ::std::option::Option<::std::string::String>,
    /// <p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).</p>
    pub state: ::std::option::Option<crate::types::EntityState>,
    /// <p>The date and time when a user was registered to WorkMail, in UNIX epoch time format.</p>
    pub enabled_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.</p>
    pub disabled_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>If the value is set to <i>true</i>, the group is hidden from the address book.</p>
    pub hidden_from_global_address_list: bool,
    _request_id: Option<String>,
}
impl DescribeGroupOutput {
    /// <p>The identifier of the described group.</p>
    pub fn group_id(&self) -> ::std::option::Option<&str> {
        self.group_id.as_deref()
    }
    /// <p>The name of the described group.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The email of the described group.</p>
    pub fn email(&self) -> ::std::option::Option<&str> {
        self.email.as_deref()
    }
    /// <p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).</p>
    pub fn state(&self) -> ::std::option::Option<&crate::types::EntityState> {
        self.state.as_ref()
    }
    /// <p>The date and time when a user was registered to WorkMail, in UNIX epoch time format.</p>
    pub fn enabled_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.enabled_date.as_ref()
    }
    /// <p>The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.</p>
    pub fn disabled_date(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.disabled_date.as_ref()
    }
    /// <p>If the value is set to <i>true</i>, the group is hidden from the address book.</p>
    pub fn hidden_from_global_address_list(&self) -> bool {
        self.hidden_from_global_address_list
    }
}
impl ::aws_types::request_id::RequestId for DescribeGroupOutput {
    fn request_id(&self) -> Option<&str> {
        self._request_id.as_deref()
    }
}
impl DescribeGroupOutput {
    /// Creates a new builder-style object to manufacture [`DescribeGroupOutput`](crate::operation::describe_group::DescribeGroupOutput).
    pub fn builder() -> crate::operation::describe_group::builders::DescribeGroupOutputBuilder {
        crate::operation::describe_group::builders::DescribeGroupOutputBuilder::default()
    }
}

/// A builder for [`DescribeGroupOutput`](crate::operation::describe_group::DescribeGroupOutput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct DescribeGroupOutputBuilder {
    pub(crate) group_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) email: ::std::option::Option<::std::string::String>,
    pub(crate) state: ::std::option::Option<crate::types::EntityState>,
    pub(crate) enabled_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) disabled_date: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) hidden_from_global_address_list: ::std::option::Option<bool>,
    _request_id: Option<String>,
}
impl DescribeGroupOutputBuilder {
    /// <p>The identifier of the described group.</p>
    pub fn group_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.group_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the described group.</p>
    pub fn set_group_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.group_id = input;
        self
    }
    /// <p>The identifier of the described group.</p>
    pub fn get_group_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.group_id
    }
    /// <p>The name of the described group.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the described group.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the described group.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The email of the described group.</p>
    pub fn email(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.email = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The email of the described group.</p>
    pub fn set_email(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.email = input;
        self
    }
    /// <p>The email of the described group.</p>
    pub fn get_email(&self) -> &::std::option::Option<::std::string::String> {
        &self.email
    }
    /// <p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).</p>
    pub fn state(mut self, input: crate::types::EntityState) -> Self {
        self.state = ::std::option::Option::Some(input);
        self
    }
    /// <p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).</p>
    pub fn set_state(mut self, input: ::std::option::Option<crate::types::EntityState>) -> Self {
        self.state = input;
        self
    }
    /// <p>The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).</p>
    pub fn get_state(&self) -> &::std::option::Option<crate::types::EntityState> {
        &self.state
    }
    /// <p>The date and time when a user was registered to WorkMail, in UNIX epoch time format.</p>
    pub fn enabled_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.enabled_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time when a user was registered to WorkMail, in UNIX epoch time format.</p>
    pub fn set_enabled_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.enabled_date = input;
        self
    }
    /// <p>The date and time when a user was registered to WorkMail, in UNIX epoch time format.</p>
    pub fn get_enabled_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.enabled_date
    }
    /// <p>The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.</p>
    pub fn disabled_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.disabled_date = ::std::option::Option::Some(input);
        self
    }
    /// <p>The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.</p>
    pub fn set_disabled_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.disabled_date = input;
        self
    }
    /// <p>The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.</p>
    pub fn get_disabled_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.disabled_date
    }
    /// <p>If the value is set to <i>true</i>, the group is hidden from the address book.</p>
    pub fn hidden_from_global_address_list(mut self, input: bool) -> Self {
        self.hidden_from_global_address_list = ::std::option::Option::Some(input);
        self
    }
    /// <p>If the value is set to <i>true</i>, the group is hidden from the address book.</p>
    pub fn set_hidden_from_global_address_list(mut self, input: ::std::option::Option<bool>) -> Self {
        self.hidden_from_global_address_list = input;
        self
    }
    /// <p>If the value is set to <i>true</i>, the group is hidden from the address book.</p>
    pub fn get_hidden_from_global_address_list(&self) -> &::std::option::Option<bool> {
        &self.hidden_from_global_address_list
    }
    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 [`DescribeGroupOutput`](crate::operation::describe_group::DescribeGroupOutput).
    pub fn build(self) -> crate::operation::describe_group::DescribeGroupOutput {
        crate::operation::describe_group::DescribeGroupOutput {
            group_id: self.group_id,
            name: self.name,
            email: self.email,
            state: self.state,
            enabled_date: self.enabled_date,
            disabled_date: self.disabled_date,
            hidden_from_global_address_list: self.hidden_from_global_address_list.unwrap_or_default(),
            _request_id: self._request_id,
        }
    }
}