#[non_exhaustive]pub struct TopicCalculatedFieldBuilder { /* private fields */ }
Expand description
A builder for TopicCalculatedField
.
Implementations§
source§impl TopicCalculatedFieldBuilder
impl TopicCalculatedFieldBuilder
sourcepub fn calculated_field_name(self, input: impl Into<String>) -> Self
pub fn calculated_field_name(self, input: impl Into<String>) -> Self
The calculated field name.
This field is required.sourcepub fn set_calculated_field_name(self, input: Option<String>) -> Self
pub fn set_calculated_field_name(self, input: Option<String>) -> Self
The calculated field name.
sourcepub fn get_calculated_field_name(&self) -> &Option<String>
pub fn get_calculated_field_name(&self) -> &Option<String>
The calculated field name.
sourcepub fn calculated_field_description(self, input: impl Into<String>) -> Self
pub fn calculated_field_description(self, input: impl Into<String>) -> Self
The calculated field description.
sourcepub fn set_calculated_field_description(self, input: Option<String>) -> Self
pub fn set_calculated_field_description(self, input: Option<String>) -> Self
The calculated field description.
sourcepub fn get_calculated_field_description(&self) -> &Option<String>
pub fn get_calculated_field_description(&self) -> &Option<String>
The calculated field description.
sourcepub fn expression(self, input: impl Into<String>) -> Self
pub fn expression(self, input: impl Into<String>) -> Self
The calculated field expression.
This field is required.sourcepub fn set_expression(self, input: Option<String>) -> Self
pub fn set_expression(self, input: Option<String>) -> Self
The calculated field expression.
sourcepub fn get_expression(&self) -> &Option<String>
pub fn get_expression(&self) -> &Option<String>
The calculated field expression.
sourcepub fn calculated_field_synonyms(self, input: impl Into<String>) -> Self
pub fn calculated_field_synonyms(self, input: impl Into<String>) -> Self
Appends an item to calculated_field_synonyms
.
To override the contents of this collection use set_calculated_field_synonyms
.
The other names or aliases for the calculated field.
sourcepub fn set_calculated_field_synonyms(self, input: Option<Vec<String>>) -> Self
pub fn set_calculated_field_synonyms(self, input: Option<Vec<String>>) -> Self
The other names or aliases for the calculated field.
sourcepub fn get_calculated_field_synonyms(&self) -> &Option<Vec<String>>
pub fn get_calculated_field_synonyms(&self) -> &Option<Vec<String>>
The other names or aliases for the calculated field.
sourcepub fn is_included_in_topic(self, input: bool) -> Self
pub fn is_included_in_topic(self, input: bool) -> Self
A boolean value that indicates if a calculated field is included in the topic.
sourcepub fn set_is_included_in_topic(self, input: Option<bool>) -> Self
pub fn set_is_included_in_topic(self, input: Option<bool>) -> Self
A boolean value that indicates if a calculated field is included in the topic.
sourcepub fn get_is_included_in_topic(&self) -> &Option<bool>
pub fn get_is_included_in_topic(&self) -> &Option<bool>
A boolean value that indicates if a calculated field is included in the topic.
sourcepub fn disable_indexing(self, input: bool) -> Self
pub fn disable_indexing(self, input: bool) -> Self
A Boolean value that indicates if a calculated field is visible in the autocomplete.
sourcepub fn set_disable_indexing(self, input: Option<bool>) -> Self
pub fn set_disable_indexing(self, input: Option<bool>) -> Self
A Boolean value that indicates if a calculated field is visible in the autocomplete.
sourcepub fn get_disable_indexing(&self) -> &Option<bool>
pub fn get_disable_indexing(&self) -> &Option<bool>
A Boolean value that indicates if a calculated field is visible in the autocomplete.
sourcepub fn column_data_role(self, input: ColumnDataRole) -> Self
pub fn column_data_role(self, input: ColumnDataRole) -> Self
The column data role for a calculated field. Valid values for this structure are DIMENSION
and MEASURE
.
sourcepub fn set_column_data_role(self, input: Option<ColumnDataRole>) -> Self
pub fn set_column_data_role(self, input: Option<ColumnDataRole>) -> Self
The column data role for a calculated field. Valid values for this structure are DIMENSION
and MEASURE
.
sourcepub fn get_column_data_role(&self) -> &Option<ColumnDataRole>
pub fn get_column_data_role(&self) -> &Option<ColumnDataRole>
The column data role for a calculated field. Valid values for this structure are DIMENSION
and MEASURE
.
sourcepub fn time_granularity(self, input: TopicTimeGranularity) -> Self
pub fn time_granularity(self, input: TopicTimeGranularity) -> Self
The level of time precision that is used to aggregate DateTime
values.
sourcepub fn set_time_granularity(self, input: Option<TopicTimeGranularity>) -> Self
pub fn set_time_granularity(self, input: Option<TopicTimeGranularity>) -> Self
The level of time precision that is used to aggregate DateTime
values.
sourcepub fn get_time_granularity(&self) -> &Option<TopicTimeGranularity>
pub fn get_time_granularity(&self) -> &Option<TopicTimeGranularity>
The level of time precision that is used to aggregate DateTime
values.
sourcepub fn default_formatting(self, input: DefaultFormatting) -> Self
pub fn default_formatting(self, input: DefaultFormatting) -> Self
The default formatting definition.
sourcepub fn set_default_formatting(self, input: Option<DefaultFormatting>) -> Self
pub fn set_default_formatting(self, input: Option<DefaultFormatting>) -> Self
The default formatting definition.
sourcepub fn get_default_formatting(&self) -> &Option<DefaultFormatting>
pub fn get_default_formatting(&self) -> &Option<DefaultFormatting>
The default formatting definition.
sourcepub fn aggregation(self, input: DefaultAggregation) -> Self
pub fn aggregation(self, input: DefaultAggregation) -> Self
The default aggregation. Valid values for this structure are SUM
, MAX
, MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.
sourcepub fn set_aggregation(self, input: Option<DefaultAggregation>) -> Self
pub fn set_aggregation(self, input: Option<DefaultAggregation>) -> Self
The default aggregation. Valid values for this structure are SUM
, MAX
, MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.
sourcepub fn get_aggregation(&self) -> &Option<DefaultAggregation>
pub fn get_aggregation(&self) -> &Option<DefaultAggregation>
The default aggregation. Valid values for this structure are SUM
, MAX
, MIN
, COUNT
, DISTINCT_COUNT
, and AVERAGE
.
sourcepub fn comparative_order(self, input: ComparativeOrder) -> Self
pub fn comparative_order(self, input: ComparativeOrder) -> Self
The order in which data is displayed for the calculated field when it's used in a comparative context.
sourcepub fn set_comparative_order(self, input: Option<ComparativeOrder>) -> Self
pub fn set_comparative_order(self, input: Option<ComparativeOrder>) -> Self
The order in which data is displayed for the calculated field when it's used in a comparative context.
sourcepub fn get_comparative_order(&self) -> &Option<ComparativeOrder>
pub fn get_comparative_order(&self) -> &Option<ComparativeOrder>
The order in which data is displayed for the calculated field when it's used in a comparative context.
sourcepub fn semantic_type(self, input: SemanticType) -> Self
pub fn semantic_type(self, input: SemanticType) -> Self
The semantic type.
sourcepub fn set_semantic_type(self, input: Option<SemanticType>) -> Self
pub fn set_semantic_type(self, input: Option<SemanticType>) -> Self
The semantic type.
sourcepub fn get_semantic_type(&self) -> &Option<SemanticType>
pub fn get_semantic_type(&self) -> &Option<SemanticType>
The semantic type.
sourcepub fn allowed_aggregations(self, input: AuthorSpecifiedAggregation) -> Self
pub fn allowed_aggregations(self, input: AuthorSpecifiedAggregation) -> Self
Appends an item to allowed_aggregations
.
To override the contents of this collection use set_allowed_aggregations
.
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
.
sourcepub fn set_allowed_aggregations(
self,
input: Option<Vec<AuthorSpecifiedAggregation>>
) -> Self
pub fn set_allowed_aggregations( self, input: Option<Vec<AuthorSpecifiedAggregation>> ) -> Self
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
.
sourcepub fn get_allowed_aggregations(
&self
) -> &Option<Vec<AuthorSpecifiedAggregation>>
pub fn get_allowed_aggregations( &self ) -> &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
.
sourcepub fn not_allowed_aggregations(self, input: AuthorSpecifiedAggregation) -> Self
pub fn not_allowed_aggregations(self, input: AuthorSpecifiedAggregation) -> Self
Appends an item to not_allowed_aggregations
.
To override the contents of this collection use set_not_allowed_aggregations
.
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
.
sourcepub fn set_not_allowed_aggregations(
self,
input: Option<Vec<AuthorSpecifiedAggregation>>
) -> Self
pub fn set_not_allowed_aggregations( self, input: Option<Vec<AuthorSpecifiedAggregation>> ) -> Self
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
.
sourcepub fn get_not_allowed_aggregations(
&self
) -> &Option<Vec<AuthorSpecifiedAggregation>>
pub fn get_not_allowed_aggregations( &self ) -> &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
.
sourcepub fn never_aggregate_in_filter(self, input: bool) -> Self
pub fn never_aggregate_in_filter(self, input: bool) -> Self
A Boolean value that indicates whether to never aggregate calculated field in filters.
sourcepub fn set_never_aggregate_in_filter(self, input: Option<bool>) -> Self
pub fn set_never_aggregate_in_filter(self, input: Option<bool>) -> Self
A Boolean value that indicates whether to never aggregate calculated field in filters.
sourcepub fn get_never_aggregate_in_filter(&self) -> &Option<bool>
pub fn get_never_aggregate_in_filter(&self) -> &Option<bool>
A Boolean value that indicates whether to never aggregate calculated field in filters.
sourcepub fn cell_value_synonyms(self, input: CellValueSynonym) -> Self
pub fn cell_value_synonyms(self, input: CellValueSynonym) -> Self
Appends an item to cell_value_synonyms
.
To override the contents of this collection use set_cell_value_synonyms
.
The other names or aliases for the calculated field cell value.
sourcepub fn set_cell_value_synonyms(
self,
input: Option<Vec<CellValueSynonym>>
) -> Self
pub fn set_cell_value_synonyms( self, input: Option<Vec<CellValueSynonym>> ) -> Self
The other names or aliases for the calculated field cell value.
sourcepub fn get_cell_value_synonyms(&self) -> &Option<Vec<CellValueSynonym>>
pub fn get_cell_value_synonyms(&self) -> &Option<Vec<CellValueSynonym>>
The other names or aliases for the calculated field cell value.
sourcepub fn non_additive(self, input: bool) -> Self
pub fn non_additive(self, input: bool) -> Self
The non additive for the table style target.
sourcepub fn set_non_additive(self, input: Option<bool>) -> Self
pub fn set_non_additive(self, input: Option<bool>) -> Self
The non additive for the table style target.
sourcepub fn get_non_additive(&self) -> &Option<bool>
pub fn get_non_additive(&self) -> &Option<bool>
The non additive for the table style target.
sourcepub fn build(self) -> Result<TopicCalculatedField, BuildError>
pub fn build(self) -> Result<TopicCalculatedField, BuildError>
Consumes the builder and constructs a TopicCalculatedField
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for TopicCalculatedFieldBuilder
impl Clone for TopicCalculatedFieldBuilder
source§fn clone(&self) -> TopicCalculatedFieldBuilder
fn clone(&self) -> TopicCalculatedFieldBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TopicCalculatedFieldBuilder
impl Debug for TopicCalculatedFieldBuilder
source§impl Default for TopicCalculatedFieldBuilder
impl Default for TopicCalculatedFieldBuilder
source§fn default() -> TopicCalculatedFieldBuilder
fn default() -> TopicCalculatedFieldBuilder
source§impl PartialEq for TopicCalculatedFieldBuilder
impl PartialEq for TopicCalculatedFieldBuilder
source§fn eq(&self, other: &TopicCalculatedFieldBuilder) -> bool
fn eq(&self, other: &TopicCalculatedFieldBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.