Struct aws_sdk_quicksight::types::StringParameterDeclaration

#[non_exhaustive]
pub struct StringParameterDeclaration {
    pub parameter_value_type: ParameterValueType,
    pub name: String,
    pub default_values: Option<StringDefaultValues>,
    pub value_when_unset: Option<StringValueWhenUnsetConfiguration>,
    pub mapped_data_set_parameters: Option<Vec<MappedDataSetParameter>>,
}

A parameter declaration for the String data type.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parameter_value_type: ParameterValueType

The value type determines whether the parameter is a single-value or multi-value parameter.

name: String

The name of the parameter that is being declared.

default_values: Option<StringDefaultValues>

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

value_when_unset: Option<StringValueWhenUnsetConfiguration>

The configuration that defines the default value of a String parameter when a value has not been set.

mapped_data_set_parameters: Option<Vec<MappedDataSetParameter>>

A list of dataset parameters that are mapped to an analysis parameter.

Implementations

impl StringParameterDeclaration

pub fn parameter_value_type(&self) -> &ParameterValueType

The value type determines whether the parameter is a single-value or multi-value parameter.

pub fn name(&self) -> &str

The name of the parameter that is being declared.

pub fn default_values(&self) -> Option<&StringDefaultValues>

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

pub fn value_when_unset(&self) -> Option<&StringValueWhenUnsetConfiguration>

The configuration that defines the default value of a String parameter when a value has not been set.

pub fn mapped_data_set_parameters(&self) -> &[MappedDataSetParameter]

A list of dataset parameters that are mapped to an analysis parameter.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .mapped_data_set_parameters.is_none().

impl StringParameterDeclaration

pub fn builder() -> StringParameterDeclarationBuilder

Creates a new builder-style object to manufacture StringParameterDeclaration.

Trait Implementations

impl Clone for StringParameterDeclaration

fn clone(&self) -> StringParameterDeclaration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StringParameterDeclaration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for StringParameterDeclaration

fn eq(&self, other: &StringParameterDeclaration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StringParameterDeclaration