aws-sdk-ivs 1.49.0

AWS SDK for Amazon Interactive Video Service
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

// 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 ListChannelsInput {
    /// <p>Filters the channel list to match the specified name.</p>
    pub filter_by_name: ::std::option::Option<::std::string::String>,
    /// <p>Filters the channel list to match the specified recording-configuration ARN.</p>
    pub filter_by_recording_configuration_arn: ::std::option::Option<::std::string::String>,
    /// <p>Filters the channel list to match the specified policy.</p>
    pub filter_by_playback_restriction_policy_arn: ::std::option::Option<::std::string::String>,
    /// <p>The first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
    pub next_token: ::std::option::Option<::std::string::String>,
    /// <p>Maximum number of channels to return. Default: 100.</p>
    pub max_results: ::std::option::Option<i32>,
}
impl ListChannelsInput {
    /// <p>Filters the channel list to match the specified name.</p>
    pub fn filter_by_name(&self) -> ::std::option::Option<&str> {
        self.filter_by_name.as_deref()
    }
    /// <p>Filters the channel list to match the specified recording-configuration ARN.</p>
    pub fn filter_by_recording_configuration_arn(&self) -> ::std::option::Option<&str> {
        self.filter_by_recording_configuration_arn.as_deref()
    }
    /// <p>Filters the channel list to match the specified policy.</p>
    pub fn filter_by_playback_restriction_policy_arn(&self) -> ::std::option::Option<&str> {
        self.filter_by_playback_restriction_policy_arn.as_deref()
    }
    /// <p>The first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
    pub fn next_token(&self) -> ::std::option::Option<&str> {
        self.next_token.as_deref()
    }
    /// <p>Maximum number of channels to return. Default: 100.</p>
    pub fn max_results(&self) -> ::std::option::Option<i32> {
        self.max_results
    }
}
impl ListChannelsInput {
    /// Creates a new builder-style object to manufacture [`ListChannelsInput`](crate::operation::list_channels::ListChannelsInput).
    pub fn builder() -> crate::operation::list_channels::builders::ListChannelsInputBuilder {
        crate::operation::list_channels::builders::ListChannelsInputBuilder::default()
    }
}

/// A builder for [`ListChannelsInput`](crate::operation::list_channels::ListChannelsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ListChannelsInputBuilder {
    pub(crate) filter_by_name: ::std::option::Option<::std::string::String>,
    pub(crate) filter_by_recording_configuration_arn: ::std::option::Option<::std::string::String>,
    pub(crate) filter_by_playback_restriction_policy_arn: ::std::option::Option<::std::string::String>,
    pub(crate) next_token: ::std::option::Option<::std::string::String>,
    pub(crate) max_results: ::std::option::Option<i32>,
}
impl ListChannelsInputBuilder {
    /// <p>Filters the channel list to match the specified name.</p>
    pub fn filter_by_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.filter_by_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Filters the channel list to match the specified name.</p>
    pub fn set_filter_by_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.filter_by_name = input;
        self
    }
    /// <p>Filters the channel list to match the specified name.</p>
    pub fn get_filter_by_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.filter_by_name
    }
    /// <p>Filters the channel list to match the specified recording-configuration ARN.</p>
    pub fn filter_by_recording_configuration_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.filter_by_recording_configuration_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Filters the channel list to match the specified recording-configuration ARN.</p>
    pub fn set_filter_by_recording_configuration_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.filter_by_recording_configuration_arn = input;
        self
    }
    /// <p>Filters the channel list to match the specified recording-configuration ARN.</p>
    pub fn get_filter_by_recording_configuration_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.filter_by_recording_configuration_arn
    }
    /// <p>Filters the channel list to match the specified policy.</p>
    pub fn filter_by_playback_restriction_policy_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.filter_by_playback_restriction_policy_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Filters the channel list to match the specified policy.</p>
    pub fn set_filter_by_playback_restriction_policy_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.filter_by_playback_restriction_policy_arn = input;
        self
    }
    /// <p>Filters the channel list to match the specified policy.</p>
    pub fn get_filter_by_playback_restriction_policy_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.filter_by_playback_restriction_policy_arn
    }
    /// <p>The first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</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 first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.next_token = input;
        self
    }
    /// <p>The first channel to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.next_token
    }
    /// <p>Maximum number of channels to return. Default: 100.</p>
    pub fn max_results(mut self, input: i32) -> Self {
        self.max_results = ::std::option::Option::Some(input);
        self
    }
    /// <p>Maximum number of channels to return. Default: 100.</p>
    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
        self.max_results = input;
        self
    }
    /// <p>Maximum number of channels to return. Default: 100.</p>
    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
        &self.max_results
    }
    /// Consumes the builder and constructs a [`ListChannelsInput`](crate::operation::list_channels::ListChannelsInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::list_channels::ListChannelsInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::list_channels::ListChannelsInput {
            filter_by_name: self.filter_by_name,
            filter_by_recording_configuration_arn: self.filter_by_recording_configuration_arn,
            filter_by_playback_restriction_policy_arn: self.filter_by_playback_restriction_policy_arn,
            next_token: self.next_token,
            max_results: self.max_results,
        })
    }
}