aws_sdk_mediapackagev2/operation/update_channel/
_update_channel_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 UpdateChannelInput {
6    /// <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
7    pub channel_group_name: ::std::option::Option<::std::string::String>,
8    /// <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
9    pub channel_name: ::std::option::Option<::std::string::String>,
10    /// <p>The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.</p>
11    pub e_tag: ::std::option::Option<::std::string::String>,
12    /// <p>Any descriptive information that you want to add to the channel for future identification purposes.</p>
13    pub description: ::std::option::Option<::std::string::String>,
14    /// <p>The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
15    pub input_switch_configuration: ::std::option::Option<crate::types::InputSwitchConfiguration>,
16    /// <p>The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
17    pub output_header_configuration: ::std::option::Option<crate::types::OutputHeaderConfiguration>,
18}
19impl UpdateChannelInput {
20    /// <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
21    pub fn channel_group_name(&self) -> ::std::option::Option<&str> {
22        self.channel_group_name.as_deref()
23    }
24    /// <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
25    pub fn channel_name(&self) -> ::std::option::Option<&str> {
26        self.channel_name.as_deref()
27    }
28    /// <p>The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.</p>
29    pub fn e_tag(&self) -> ::std::option::Option<&str> {
30        self.e_tag.as_deref()
31    }
32    /// <p>Any descriptive information that you want to add to the channel for future identification purposes.</p>
33    pub fn description(&self) -> ::std::option::Option<&str> {
34        self.description.as_deref()
35    }
36    /// <p>The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
37    pub fn input_switch_configuration(&self) -> ::std::option::Option<&crate::types::InputSwitchConfiguration> {
38        self.input_switch_configuration.as_ref()
39    }
40    /// <p>The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
41    pub fn output_header_configuration(&self) -> ::std::option::Option<&crate::types::OutputHeaderConfiguration> {
42        self.output_header_configuration.as_ref()
43    }
44}
45impl UpdateChannelInput {
46    /// Creates a new builder-style object to manufacture [`UpdateChannelInput`](crate::operation::update_channel::UpdateChannelInput).
47    pub fn builder() -> crate::operation::update_channel::builders::UpdateChannelInputBuilder {
48        crate::operation::update_channel::builders::UpdateChannelInputBuilder::default()
49    }
50}
51
52/// A builder for [`UpdateChannelInput`](crate::operation::update_channel::UpdateChannelInput).
53#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
54#[non_exhaustive]
55pub struct UpdateChannelInputBuilder {
56    pub(crate) channel_group_name: ::std::option::Option<::std::string::String>,
57    pub(crate) channel_name: ::std::option::Option<::std::string::String>,
58    pub(crate) e_tag: ::std::option::Option<::std::string::String>,
59    pub(crate) description: ::std::option::Option<::std::string::String>,
60    pub(crate) input_switch_configuration: ::std::option::Option<crate::types::InputSwitchConfiguration>,
61    pub(crate) output_header_configuration: ::std::option::Option<crate::types::OutputHeaderConfiguration>,
62}
63impl UpdateChannelInputBuilder {
64    /// <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
65    /// This field is required.
66    pub fn channel_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
67        self.channel_group_name = ::std::option::Option::Some(input.into());
68        self
69    }
70    /// <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
71    pub fn set_channel_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
72        self.channel_group_name = input;
73        self
74    }
75    /// <p>The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.</p>
76    pub fn get_channel_group_name(&self) -> &::std::option::Option<::std::string::String> {
77        &self.channel_group_name
78    }
79    /// <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
80    /// This field is required.
81    pub fn channel_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
82        self.channel_name = ::std::option::Option::Some(input.into());
83        self
84    }
85    /// <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
86    pub fn set_channel_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
87        self.channel_name = input;
88        self
89    }
90    /// <p>The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.</p>
91    pub fn get_channel_name(&self) -> &::std::option::Option<::std::string::String> {
92        &self.channel_name
93    }
94    /// <p>The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.</p>
95    pub fn e_tag(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
96        self.e_tag = ::std::option::Option::Some(input.into());
97        self
98    }
99    /// <p>The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.</p>
100    pub fn set_e_tag(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
101        self.e_tag = input;
102        self
103    }
104    /// <p>The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.</p>
105    pub fn get_e_tag(&self) -> &::std::option::Option<::std::string::String> {
106        &self.e_tag
107    }
108    /// <p>Any descriptive information that you want to add to the channel for future identification purposes.</p>
109    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
110        self.description = ::std::option::Option::Some(input.into());
111        self
112    }
113    /// <p>Any descriptive information that you want to add to the channel for future identification purposes.</p>
114    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
115        self.description = input;
116        self
117    }
118    /// <p>Any descriptive information that you want to add to the channel for future identification purposes.</p>
119    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
120        &self.description
121    }
122    /// <p>The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
123    pub fn input_switch_configuration(mut self, input: crate::types::InputSwitchConfiguration) -> Self {
124        self.input_switch_configuration = ::std::option::Option::Some(input);
125        self
126    }
127    /// <p>The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
128    pub fn set_input_switch_configuration(mut self, input: ::std::option::Option<crate::types::InputSwitchConfiguration>) -> Self {
129        self.input_switch_configuration = input;
130        self
131    }
132    /// <p>The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
133    pub fn get_input_switch_configuration(&self) -> &::std::option::Option<crate::types::InputSwitchConfiguration> {
134        &self.input_switch_configuration
135    }
136    /// <p>The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
137    pub fn output_header_configuration(mut self, input: crate::types::OutputHeaderConfiguration) -> Self {
138        self.output_header_configuration = ::std::option::Option::Some(input);
139        self
140    }
141    /// <p>The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
142    pub fn set_output_header_configuration(mut self, input: ::std::option::Option<crate::types::OutputHeaderConfiguration>) -> Self {
143        self.output_header_configuration = input;
144        self
145    }
146    /// <p>The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when <code>InputType</code> is <code>CMAF</code>.</p>
147    pub fn get_output_header_configuration(&self) -> &::std::option::Option<crate::types::OutputHeaderConfiguration> {
148        &self.output_header_configuration
149    }
150    /// Consumes the builder and constructs a [`UpdateChannelInput`](crate::operation::update_channel::UpdateChannelInput).
151    pub fn build(
152        self,
153    ) -> ::std::result::Result<crate::operation::update_channel::UpdateChannelInput, ::aws_smithy_types::error::operation::BuildError> {
154        ::std::result::Result::Ok(crate::operation::update_channel::UpdateChannelInput {
155            channel_group_name: self.channel_group_name,
156            channel_name: self.channel_name,
157            e_tag: self.e_tag,
158            description: self.description,
159            input_switch_configuration: self.input_switch_configuration,
160            output_header_configuration: self.output_header_configuration,
161        })
162    }
163}