Struct aws_sdk_quicksight::types::TopicCalculatedField

#[non_exhaustive]
pub struct TopicCalculatedField {

    pub calculated_field_name: String,
    pub calculated_field_description: Option<String>,
    pub expression: String,
    pub calculated_field_synonyms: Option<Vec<String>>,
    pub is_included_in_topic: bool,
    pub disable_indexing: Option<bool>,
    pub column_data_role: Option<ColumnDataRole>,
    pub time_granularity: Option<TopicTimeGranularity>,
    pub default_formatting: Option<DefaultFormatting>,
    pub aggregation: Option<DefaultAggregation>,
    pub comparative_order: Option<ComparativeOrder>,
    pub semantic_type: Option<SemanticType>,
    pub allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>,
    pub not_allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>,
    pub never_aggregate_in_filter: bool,
    pub cell_value_synonyms: Option<Vec<CellValueSynonym>>,
    pub non_additive: Option<bool>,
}

A structure that represents a calculated field.

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.

calculated_field_name: String

The calculated field name.

calculated_field_description: Option<String>

The calculated field description.

expression: String

The calculated field expression.

calculated_field_synonyms: Option<Vec<String>>

The other names or aliases for the calculated field.

is_included_in_topic: bool

A boolean value that indicates if a calculated field is included in the topic.

disable_indexing: Option<bool>

A Boolean value that indicates if a calculated field is visible in the autocomplete.

column_data_role: Option<ColumnDataRole>

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

time_granularity: Option<TopicTimeGranularity>

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

default_formatting: Option<DefaultFormatting>

The default formatting definition.

aggregation: Option<DefaultAggregation>

The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.

comparative_order: Option<ComparativeOrder>

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

semantic_type: Option<SemanticType>

The semantic type.

allowed_aggregations: Option<Vec<AuthorSpecifiedAggregation>>

The list of aggregation types that are allowed for the calculated field. 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 calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.

never_aggregate_in_filter: bool

A Boolean value that indicates whether to never aggregate calculated field in filters.

cell_value_synonyms: Option<Vec<CellValueSynonym>>

The other names or aliases for the calculated field cell value.

non_additive: Option<bool>

The non additive for the table style target.

Implementations

impl TopicCalculatedField

pub fn calculated_field_name(&self) -> &str

The calculated field name.

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

The calculated field description.

pub fn expression(&self) -> &str

The calculated field expression.

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

The other names or aliases for the calculated field.

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

pub fn is_included_in_topic(&self) -> bool

A boolean value that indicates if a calculated field is included in the topic.

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

A Boolean value that indicates if a calculated field is visible in the autocomplete.

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

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

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

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

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

The default formatting definition.

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

The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.

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

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

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

The semantic type.

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

The list of aggregation types that are allowed for the calculated field. 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 calculated field. 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 never_aggregate_in_filter(&self) -> bool

A Boolean value that indicates whether to never aggregate calculated field in filters.

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

The other names or aliases for the calculated field 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 for the table style target.

impl TopicCalculatedField

pub fn builder() -> TopicCalculatedFieldBuilder

Creates a new builder-style object to manufacture TopicCalculatedField.

Trait Implementations

impl Clone for TopicCalculatedField

fn clone(&self) -> TopicCalculatedField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TopicCalculatedField

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

Formats the value using the given formatter.

impl PartialEq for TopicCalculatedField

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for TopicCalculatedField