aws-sdk-ivs 1.110.0

AWS SDK for Amazon Interactive Video Service
Documentation
// 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 UpdateAdConfigurationInput {
    /// <p>ARN of the ad configuration to be updated.</p>
    pub arn: ::std::option::Option<::std::string::String>,
    /// <p>Ad configuration name. The value does not need to be unique.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/private-channels-generate-tokens.html">Generate and Sign IVS Playback Tokens</a>.</p>
    pub media_tailor_playback_configurations: ::std::option::Option<::std::vec::Vec<crate::types::MediaTailorPlaybackConfiguration>>,
}
impl UpdateAdConfigurationInput {
    /// <p>ARN of the ad configuration to be updated.</p>
    pub fn arn(&self) -> ::std::option::Option<&str> {
        self.arn.as_deref()
    }
    /// <p>Ad configuration name. The value does not need to be unique.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/private-channels-generate-tokens.html">Generate and Sign IVS Playback Tokens</a>.</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 `.media_tailor_playback_configurations.is_none()`.
    pub fn media_tailor_playback_configurations(&self) -> &[crate::types::MediaTailorPlaybackConfiguration] {
        self.media_tailor_playback_configurations.as_deref().unwrap_or_default()
    }
}
impl UpdateAdConfigurationInput {
    /// Creates a new builder-style object to manufacture [`UpdateAdConfigurationInput`](crate::operation::update_ad_configuration::UpdateAdConfigurationInput).
    pub fn builder() -> crate::operation::update_ad_configuration::builders::UpdateAdConfigurationInputBuilder {
        crate::operation::update_ad_configuration::builders::UpdateAdConfigurationInputBuilder::default()
    }
}

/// A builder for [`UpdateAdConfigurationInput`](crate::operation::update_ad_configuration::UpdateAdConfigurationInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateAdConfigurationInputBuilder {
    pub(crate) arn: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) media_tailor_playback_configurations: ::std::option::Option<::std::vec::Vec<crate::types::MediaTailorPlaybackConfiguration>>,
}
impl UpdateAdConfigurationInputBuilder {
    /// <p>ARN of the ad configuration to be updated.</p>
    /// This field is required.
    pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>ARN of the ad configuration to be updated.</p>
    pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.arn = input;
        self
    }
    /// <p>ARN of the ad configuration to be updated.</p>
    pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.arn
    }
    /// <p>Ad configuration name. The value does not need to be unique.</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>Ad configuration name. The value does not need to be unique.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>Ad configuration name. The value does not need to be unique.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// Appends an item to `media_tailor_playback_configurations`.
    ///
    /// To override the contents of this collection use [`set_media_tailor_playback_configurations`](Self::set_media_tailor_playback_configurations).
    ///
    /// <p>List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/private-channels-generate-tokens.html">Generate and Sign IVS Playback Tokens</a>.</p>
    pub fn media_tailor_playback_configurations(mut self, input: crate::types::MediaTailorPlaybackConfiguration) -> Self {
        let mut v = self.media_tailor_playback_configurations.unwrap_or_default();
        v.push(input);
        self.media_tailor_playback_configurations = ::std::option::Option::Some(v);
        self
    }
    /// <p>List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/private-channels-generate-tokens.html">Generate and Sign IVS Playback Tokens</a>.</p>
    pub fn set_media_tailor_playback_configurations(
        mut self,
        input: ::std::option::Option<::std::vec::Vec<crate::types::MediaTailorPlaybackConfiguration>>,
    ) -> Self {
        self.media_tailor_playback_configurations = input;
        self
    }
    /// <p>List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/private-channels-generate-tokens.html">Generate and Sign IVS Playback Tokens</a>.</p>
    pub fn get_media_tailor_playback_configurations(
        &self,
    ) -> &::std::option::Option<::std::vec::Vec<crate::types::MediaTailorPlaybackConfiguration>> {
        &self.media_tailor_playback_configurations
    }
    /// Consumes the builder and constructs a [`UpdateAdConfigurationInput`](crate::operation::update_ad_configuration::UpdateAdConfigurationInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::update_ad_configuration::UpdateAdConfigurationInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::update_ad_configuration::UpdateAdConfigurationInput {
            arn: self.arn,
            name: self.name,
            media_tailor_playback_configurations: self.media_tailor_playback_configurations,
        })
    }
}