aws_sdk_quicksight/types/

_filter_drop_down_control.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>A control to display a dropdown list with buttons that are used to select a single value.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct FilterDropDownControl {
    /// <p>The ID of the <code>FilterDropDownControl</code>.</p>
    pub filter_control_id: ::std::string::String,
    /// <p>The title of the <code>FilterDropDownControl</code>.</p>
    pub title: ::std::string::String,
    /// <p>The source filter ID of the <code>FilterDropDownControl</code>.</p>
    pub source_filter_id: ::std::string::String,
    /// <p>The display options of the <code>FilterDropDownControl</code>.</p>
    pub display_options: ::std::option::Option<crate::types::DropDownControlDisplayOptions>,
    /// <p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p>
    /// <ul>
    /// <li>
    /// <p><code>MULTI_SELECT</code>: The user can select multiple entries from a dropdown menu.</p></li>
    /// <li>
    /// <p><code>SINGLE_SELECT</code>: The user can select a single entry from a dropdown menu.</p></li>
    /// </ul>
    pub r#type: ::std::option::Option<crate::types::SheetControlListType>,
    /// <p>A list of selectable values that are used in a control.</p>
    pub selectable_values: ::std::option::Option<crate::types::FilterSelectableValues>,
    /// <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
    pub cascading_control_configuration: ::std::option::Option<crate::types::CascadingControlConfiguration>,
    /// <p>The visibility configuration of the Apply button on a <code>FilterDropDownControl</code>.</p>
    pub commit_mode: ::std::option::Option<crate::types::CommitMode>,
}
impl FilterDropDownControl {
    /// <p>The ID of the <code>FilterDropDownControl</code>.</p>
    pub fn filter_control_id(&self) -> &str {
        use std::ops::Deref;
        self.filter_control_id.deref()
    }
    /// <p>The title of the <code>FilterDropDownControl</code>.</p>
    pub fn title(&self) -> &str {
        use std::ops::Deref;
        self.title.deref()
    }
    /// <p>The source filter ID of the <code>FilterDropDownControl</code>.</p>
    pub fn source_filter_id(&self) -> &str {
        use std::ops::Deref;
        self.source_filter_id.deref()
    }
    /// <p>The display options of the <code>FilterDropDownControl</code>.</p>
    pub fn display_options(&self) -> ::std::option::Option<&crate::types::DropDownControlDisplayOptions> {
        self.display_options.as_ref()
    }
    /// <p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p>
    /// <ul>
    /// <li>
    /// <p><code>MULTI_SELECT</code>: The user can select multiple entries from a dropdown menu.</p></li>
    /// <li>
    /// <p><code>SINGLE_SELECT</code>: The user can select a single entry from a dropdown menu.</p></li>
    /// </ul>
    pub fn r#type(&self) -> ::std::option::Option<&crate::types::SheetControlListType> {
        self.r#type.as_ref()
    }
    /// <p>A list of selectable values that are used in a control.</p>
    pub fn selectable_values(&self) -> ::std::option::Option<&crate::types::FilterSelectableValues> {
        self.selectable_values.as_ref()
    }
    /// <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
    pub fn cascading_control_configuration(&self) -> ::std::option::Option<&crate::types::CascadingControlConfiguration> {
        self.cascading_control_configuration.as_ref()
    }
    /// <p>The visibility configuration of the Apply button on a <code>FilterDropDownControl</code>.</p>
    pub fn commit_mode(&self) -> ::std::option::Option<&crate::types::CommitMode> {
        self.commit_mode.as_ref()
    }
}
impl FilterDropDownControl {
    /// Creates a new builder-style object to manufacture [`FilterDropDownControl`](crate::types::FilterDropDownControl).
    pub fn builder() -> crate::types::builders::FilterDropDownControlBuilder {
        crate::types::builders::FilterDropDownControlBuilder::default()
    }
}

/// A builder for [`FilterDropDownControl`](crate::types::FilterDropDownControl).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct FilterDropDownControlBuilder {
    pub(crate) filter_control_id: ::std::option::Option<::std::string::String>,
    pub(crate) title: ::std::option::Option<::std::string::String>,
    pub(crate) source_filter_id: ::std::option::Option<::std::string::String>,
    pub(crate) display_options: ::std::option::Option<crate::types::DropDownControlDisplayOptions>,
    pub(crate) r#type: ::std::option::Option<crate::types::SheetControlListType>,
    pub(crate) selectable_values: ::std::option::Option<crate::types::FilterSelectableValues>,
    pub(crate) cascading_control_configuration: ::std::option::Option<crate::types::CascadingControlConfiguration>,
    pub(crate) commit_mode: ::std::option::Option<crate::types::CommitMode>,
}
impl FilterDropDownControlBuilder {
    /// <p>The ID of the <code>FilterDropDownControl</code>.</p>
    /// This field is required.
    pub fn filter_control_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.filter_control_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the <code>FilterDropDownControl</code>.</p>
    pub fn set_filter_control_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.filter_control_id = input;
        self
    }
    /// <p>The ID of the <code>FilterDropDownControl</code>.</p>
    pub fn get_filter_control_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.filter_control_id
    }
    /// <p>The title of the <code>FilterDropDownControl</code>.</p>
    /// This field is required.
    pub fn title(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.title = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The title of the <code>FilterDropDownControl</code>.</p>
    pub fn set_title(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.title = input;
        self
    }
    /// <p>The title of the <code>FilterDropDownControl</code>.</p>
    pub fn get_title(&self) -> &::std::option::Option<::std::string::String> {
        &self.title
    }
    /// <p>The source filter ID of the <code>FilterDropDownControl</code>.</p>
    /// This field is required.
    pub fn source_filter_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.source_filter_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The source filter ID of the <code>FilterDropDownControl</code>.</p>
    pub fn set_source_filter_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.source_filter_id = input;
        self
    }
    /// <p>The source filter ID of the <code>FilterDropDownControl</code>.</p>
    pub fn get_source_filter_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.source_filter_id
    }
    /// <p>The display options of the <code>FilterDropDownControl</code>.</p>
    pub fn display_options(mut self, input: crate::types::DropDownControlDisplayOptions) -> Self {
        self.display_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>The display options of the <code>FilterDropDownControl</code>.</p>
    pub fn set_display_options(mut self, input: ::std::option::Option<crate::types::DropDownControlDisplayOptions>) -> Self {
        self.display_options = input;
        self
    }
    /// <p>The display options of the <code>FilterDropDownControl</code>.</p>
    pub fn get_display_options(&self) -> &::std::option::Option<crate::types::DropDownControlDisplayOptions> {
        &self.display_options
    }
    /// <p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p>
    /// <ul>
    /// <li>
    /// <p><code>MULTI_SELECT</code>: The user can select multiple entries from a dropdown menu.</p></li>
    /// <li>
    /// <p><code>SINGLE_SELECT</code>: The user can select a single entry from a dropdown menu.</p></li>
    /// </ul>
    pub fn r#type(mut self, input: crate::types::SheetControlListType) -> Self {
        self.r#type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p>
    /// <ul>
    /// <li>
    /// <p><code>MULTI_SELECT</code>: The user can select multiple entries from a dropdown menu.</p></li>
    /// <li>
    /// <p><code>SINGLE_SELECT</code>: The user can select a single entry from a dropdown menu.</p></li>
    /// </ul>
    pub fn set_type(mut self, input: ::std::option::Option<crate::types::SheetControlListType>) -> Self {
        self.r#type = input;
        self
    }
    /// <p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p>
    /// <ul>
    /// <li>
    /// <p><code>MULTI_SELECT</code>: The user can select multiple entries from a dropdown menu.</p></li>
    /// <li>
    /// <p><code>SINGLE_SELECT</code>: The user can select a single entry from a dropdown menu.</p></li>
    /// </ul>
    pub fn get_type(&self) -> &::std::option::Option<crate::types::SheetControlListType> {
        &self.r#type
    }
    /// <p>A list of selectable values that are used in a control.</p>
    pub fn selectable_values(mut self, input: crate::types::FilterSelectableValues) -> Self {
        self.selectable_values = ::std::option::Option::Some(input);
        self
    }
    /// <p>A list of selectable values that are used in a control.</p>
    pub fn set_selectable_values(mut self, input: ::std::option::Option<crate::types::FilterSelectableValues>) -> Self {
        self.selectable_values = input;
        self
    }
    /// <p>A list of selectable values that are used in a control.</p>
    pub fn get_selectable_values(&self) -> &::std::option::Option<crate::types::FilterSelectableValues> {
        &self.selectable_values
    }
    /// <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
    pub fn cascading_control_configuration(mut self, input: crate::types::CascadingControlConfiguration) -> Self {
        self.cascading_control_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
    pub fn set_cascading_control_configuration(mut self, input: ::std::option::Option<crate::types::CascadingControlConfiguration>) -> Self {
        self.cascading_control_configuration = input;
        self
    }
    /// <p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>
    pub fn get_cascading_control_configuration(&self) -> &::std::option::Option<crate::types::CascadingControlConfiguration> {
        &self.cascading_control_configuration
    }
    /// <p>The visibility configuration of the Apply button on a <code>FilterDropDownControl</code>.</p>
    pub fn commit_mode(mut self, input: crate::types::CommitMode) -> Self {
        self.commit_mode = ::std::option::Option::Some(input);
        self
    }
    /// <p>The visibility configuration of the Apply button on a <code>FilterDropDownControl</code>.</p>
    pub fn set_commit_mode(mut self, input: ::std::option::Option<crate::types::CommitMode>) -> Self {
        self.commit_mode = input;
        self
    }
    /// <p>The visibility configuration of the Apply button on a <code>FilterDropDownControl</code>.</p>
    pub fn get_commit_mode(&self) -> &::std::option::Option<crate::types::CommitMode> {
        &self.commit_mode
    }
    /// Consumes the builder and constructs a [`FilterDropDownControl`](crate::types::FilterDropDownControl).
    /// This method will fail if any of the following fields are not set:
    /// - [`filter_control_id`](crate::types::builders::FilterDropDownControlBuilder::filter_control_id)
    /// - [`title`](crate::types::builders::FilterDropDownControlBuilder::title)
    /// - [`source_filter_id`](crate::types::builders::FilterDropDownControlBuilder::source_filter_id)
    pub fn build(self) -> ::std::result::Result<crate::types::FilterDropDownControl, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::types::FilterDropDownControl {
            filter_control_id: self.filter_control_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "filter_control_id",
                    "filter_control_id was not specified but it is required when building FilterDropDownControl",
                )
            })?,
            title: self.title.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "title",
                    "title was not specified but it is required when building FilterDropDownControl",
                )
            })?,
            source_filter_id: self.source_filter_id.ok_or_else(|| {
                ::aws_smithy_types::error::operation::BuildError::missing_field(
                    "source_filter_id",
                    "source_filter_id was not specified but it is required when building FilterDropDownControl",
                )
            })?,
            display_options: self.display_options,
            r#type: self.r#type,
            selectable_values: self.selectable_values,
            cascading_control_configuration: self.cascading_control_configuration,
            commit_mode: self.commit_mode,
        })
    }
}