All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnTopic.TopicCalculatedFieldProperty.Jsii$Proxy

Enclosing class:: CfnTopic

@Stability(Stable) public static interface CfnTopic.TopicCalculatedFieldProperty extends software.amazon.jsii.JsiiSerializable

A structure that represents a calculated field.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 TopicCalculatedFieldProperty topicCalculatedFieldProperty = TopicCalculatedFieldProperty.builder()
         .calculatedFieldName("calculatedFieldName")
         .expression("expression")
         // the properties below are optional
         .aggregation("aggregation")
         .allowedAggregations(List.of("allowedAggregations"))
         .calculatedFieldDescription("calculatedFieldDescription")
         .calculatedFieldSynonyms(List.of("calculatedFieldSynonyms"))
         .cellValueSynonyms(List.of(CellValueSynonymProperty.builder()
                 .cellValue("cellValue")
                 .synonyms(List.of("synonyms"))
                 .build()))
         .columnDataRole("columnDataRole")
         .comparativeOrder(ComparativeOrderProperty.builder()
                 .specifedOrder(List.of("specifedOrder"))
                 .treatUndefinedSpecifiedValues("treatUndefinedSpecifiedValues")
                 .useOrdering("useOrdering")
                 .build())
         .defaultFormatting(DefaultFormattingProperty.builder()
                 .displayFormat("displayFormat")
                 .displayFormatOptions(DisplayFormatOptionsProperty.builder()
                         .blankCellFormat("blankCellFormat")
                         .currencySymbol("currencySymbol")
                         .dateFormat("dateFormat")
                         .decimalSeparator("decimalSeparator")
                         .fractionDigits(123)
                         .groupingSeparator("groupingSeparator")
                         .negativeFormat(NegativeFormatProperty.builder()
                                 .prefix("prefix")
                                 .suffix("suffix")
                                 .build())
                         .prefix("prefix")
                         .suffix("suffix")
                         .unitScaler("unitScaler")
                         .useBlankCellFormat(false)
                         .useGrouping(false)
                         .build())
                 .build())
         .disableIndexing(false)
         .isIncludedInTopic(false)
         .neverAggregateInFilter(false)
         .nonAdditive(false)
         .notAllowedAggregations(List.of("notAllowedAggregations"))
         .semanticType(SemanticTypeProperty.builder()
                 .falseyCellValue("falseyCellValue")
                 .falseyCellValueSynonyms(List.of("falseyCellValueSynonyms"))
                 .subTypeName("subTypeName")
                 .truthyCellValue("truthyCellValue")
                 .truthyCellValueSynonyms(List.of("truthyCellValueSynonyms"))
                 .typeName("typeName")
                 .typeParameters(Map.of(
                         "typeParametersKey", "typeParameters"))
                 .build())
         .timeGranularity("timeGranularity")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnTopic.TopicCalculatedFieldProperty.Builder

A builder for CfnTopic.TopicCalculatedFieldProperty

static final class

CfnTopic.TopicCalculatedFieldProperty.Jsii$Proxy

An implementation for CfnTopic.TopicCalculatedFieldProperty
Method Summary

Modifier and Type

Method

Description

static CfnTopic.TopicCalculatedFieldProperty.Builder

builder()

default String

getAggregation()

The default aggregation.

default List<String>

getAllowedAggregations()

The list of aggregation types that are allowed for the calculated field.

default String

getCalculatedFieldDescription()

The calculated field description.

String

getCalculatedFieldName()

The calculated field name.

default List<String>

getCalculatedFieldSynonyms()

The other names or aliases for the calculated field.

default Object

getCellValueSynonyms()

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

default String

getColumnDataRole()

The column data role for a calculated field.

default Object

getComparativeOrder()

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

default Object

getDefaultFormatting()

The default formatting definition.

default Object

getDisableIndexing()

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

String

getExpression()

The calculated field expression.

default Object

getIsIncludedInTopic()

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

default Object

getNeverAggregateInFilter()

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

default Object

getNonAdditive()

The non additive for the table style target.

default List<String>

getNotAllowedAggregations()

The list of aggregation types that are not allowed for the calculated field.

default Object

getSemanticType()

The semantic type.

default String

getTimeGranularity()

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getCalculatedFieldName
  
  @Stability(Stable) @NotNull String getCalculatedFieldName()
  
  The calculated field name.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfieldname
- getExpression
  
  @Stability(Stable) @NotNull String getExpression()
  
  The calculated field expression.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-expression
- getAggregation
  
  @Stability(Stable) @Nullable default String getAggregation()
  
  The default aggregation.
  Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT , and AVERAGE .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-aggregation
- getAllowedAggregations
  
  @Stability(Stable) @Nullable default List<String> getAllowedAggregations()
  
  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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-allowedaggregations
- getCalculatedFieldDescription
  
  @Stability(Stable) @Nullable default String getCalculatedFieldDescription()
  
  The calculated field description.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfielddescription
- getCalculatedFieldSynonyms
  
  @Stability(Stable) @Nullable default List<String> getCalculatedFieldSynonyms()
  
  The other names or aliases for the calculated field.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-calculatedfieldsynonyms
- getCellValueSynonyms
  
  @Stability(Stable) @Nullable default Object getCellValueSynonyms()
  
  The other names or aliases for the calculated field cell value.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTopic.CellValueSynonymProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-cellvaluesynonyms
- getColumnDataRole
  
  @Stability(Stable) @Nullable default String getColumnDataRole()
  
  The column data role for a calculated field.
  Valid values for this structure are DIMENSION and MEASURE .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-columndatarole
- getComparativeOrder
  
  @Stability(Stable) @Nullable default Object getComparativeOrder()
  
  The order in which data is displayed for the calculated field when it's used in a comparative context.
  Returns union: either IResolvable or CfnTopic.ComparativeOrderProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-comparativeorder
- getDefaultFormatting
  
  @Stability(Stable) @Nullable default Object getDefaultFormatting()
  
  The default formatting definition.
  Returns union: either IResolvable or CfnTopic.DefaultFormattingProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-defaultformatting
- getDisableIndexing
  
  @Stability(Stable) @Nullable default Object getDisableIndexing()
  
  A Boolean value that indicates if a calculated field is visible in the autocomplete.
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-disableindexing
- getIsIncludedInTopic
  
  @Stability(Stable) @Nullable default Object getIsIncludedInTopic()
  
  A boolean value that indicates if a calculated field is included in the topic.
  Returns union: either Boolean or IResolvable
  Default: - false
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-isincludedintopic
- getNeverAggregateInFilter
  
  @Stability(Stable) @Nullable default Object getNeverAggregateInFilter()
  
  A Boolean value that indicates whether to never aggregate calculated field in filters.
  Returns union: either Boolean or IResolvable
  Default: - false
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-neveraggregateinfilter
- getNonAdditive
  
  @Stability(Stable) @Nullable default Object getNonAdditive()
  
  The non additive for the table style target.
  Returns union: either Boolean or IResolvable
  Default: - false
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-nonadditive
- getNotAllowedAggregations
  
  @Stability(Stable) @Nullable default List<String> getNotAllowedAggregations()
  
  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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-notallowedaggregations
- getSemanticType
  
  @Stability(Stable) @Nullable default Object getSemanticType()
  
  The semantic type.
  Returns union: either IResolvable or CfnTopic.SemanticTypeProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-semantictype
- getTimeGranularity
  
  @Stability(Stable) @Nullable default String getTimeGranularity()
  
  The level of time precision that is used to aggregate DateTime values.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccalculatedfield.html#cfn-quicksight-topic-topiccalculatedfield-timegranularity
- builder
  
  @Stability(Stable) static CfnTopic.TopicCalculatedFieldProperty.Builder builder()
  
  Returns:
  
  a CfnTopic.TopicCalculatedFieldProperty.Builder of CfnTopic.TopicCalculatedFieldProperty

Interface CfnTopic.TopicCalculatedFieldProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getCalculatedFieldName

getExpression

getAggregation

getAllowedAggregations

getCalculatedFieldDescription

getCalculatedFieldSynonyms

getCellValueSynonyms

getColumnDataRole

getComparativeOrder

getDefaultFormatting

getDisableIndexing

getIsIncludedInTopic

getNeverAggregateInFilter

getNonAdditive

getNotAllowedAggregations

getSemanticType

getTimeGranularity

builder