Struct aws_sdk_quicksight::types::TopicColumn

#[non_exhaustive]
pub struct TopicColumn {

    pub column_name: String,
    pub column_friendly_name: Option<String>,
    pub column_description: Option<String>,
    pub column_synonyms: Option<Vec<String>>,
    pub column_data_role: Option<ColumnDataRole>,
    pub aggregation: Option<DefaultAggregation>,
    pub is_included_in_topic: bool,
    pub disable_indexing: Option<bool>,
    pub comparative_order: Option<ComparativeOrder>,
    pub semantic_type: Option<SemanticType>,
    pub time_granularity: Option<TopicTimeGranularity>,
    pub allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>,
    pub not_allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>,
    pub default_formatting: Option<DefaultFormatting>,
    pub never_aggregate_in_filter: bool,
    pub cell_value_synonyms: Option<Vec<CellValueSynonym>>,
    pub non_additive: Option<bool>,
}

Represents a column in a dataset.

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.

column_name: String

The name of the column.

column_friendly_name: Option<String>

A user-friendly name for the column.

column_description: Option<String>

A description of the column and its contents.

column_synonyms: Option<Vec<String>>

The other names or aliases for the column.

column_data_role: Option<ColumnDataRole>

The role of the column in the data. Valid values are DIMENSION and MEASURE.

aggregation: Option<DefaultAggregation>

The type of aggregation that is performed on the column data when it's queried.

is_included_in_topic: bool

A Boolean value that indicates whether the column is included in the query results.

disable_indexing: Option<bool>

A Boolean value that indicates whether the column shows in the autocomplete functionality.

comparative_order: Option<ComparativeOrder>

The order in which data is displayed for the column when it's used in a comparative context.

semantic_type: Option<SemanticType>

The semantic type of data contained in the column.

time_granularity: Option<TopicTimeGranularity>

The level of time precision that is used to aggregate DateTime values.

allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>

The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

not_allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>

The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

default_formatting: Option<DefaultFormatting>

The default formatting used for values in the column.

never_aggregate_in_filter: bool

A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.

cell_value_synonyms: Option<Vec<CellValueSynonym>>

The other names or aliases for the column cell value.

non_additive: Option<bool>

The non additive value for the column.

Implementations

impl TopicColumn

pub fn column_name(&self) -> &str

The name of the column.

pub fn column_friendly_name(&self) -> Option<&str>

A user-friendly name for the column.

pub fn column_description(&self) -> Option<&str>

A description of the column and its contents.

pub fn column_synonyms(&self) -> &[String]

The other names or aliases for the column.

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

pub fn column_data_role(&self) -> Option<&ColumnDataRole>

The role of the column in the data. Valid values are DIMENSION and MEASURE.

pub fn aggregation(&self) -> Option<&DefaultAggregation>

The type of aggregation that is performed on the column data when it's queried.

pub fn is_included_in_topic(&self) -> bool

A Boolean value that indicates whether the column is included in the query results.

pub fn disable_indexing(&self) -> Option<bool>

A Boolean value that indicates whether the column shows in the autocomplete functionality.

pub fn comparative_order(&self) -> Option<&ComparativeOrder>

The order in which data is displayed for the column when it's used in a comparative context.

pub fn semantic_type(&self) -> Option<&SemanticType>

The semantic type of data contained in the column.

pub fn time_granularity(&self) -> Option<&TopicTimeGranularity>

The level of time precision that is used to aggregate DateTime values.

pub fn allowed_aggregations(&self) -> &[AuthorSpecifiedAggregation]

The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

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

pub fn not_allowed_aggregations(&self) -> &[AuthorSpecifiedAggregation]

The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

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

pub fn default_formatting(&self) -> Option<&DefaultFormatting>

The default formatting used for values in the column.

pub fn never_aggregate_in_filter(&self) -> bool

A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.

pub fn cell_value_synonyms(&self) -> &[CellValueSynonym]

The other names or aliases for the column cell value.

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

pub fn non_additive(&self) -> Option<bool>

The non additive value for the column.

impl TopicColumn

pub fn builder() -> TopicColumnBuilder

Creates a new builder-style object to manufacture TopicColumn.

Trait Implementations

impl Clone for TopicColumn

fn clone(&self) -> TopicColumn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopicColumn

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

Formats the value using the given formatter.

impl PartialEq for TopicColumn

fn eq(&self, other: &TopicColumn) -> 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 TopicColumn