All Superinterfaces:: software.amazon.jsii.JsiiSerializable

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

Enclosing class:: CfnTopic

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

Represents a column in a dataset.

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.*;
 TopicColumnProperty topicColumnProperty = TopicColumnProperty.builder()
         .columnName("columnName")
         // the properties below are optional
         .aggregation("aggregation")
         .allowedAggregations(List.of("allowedAggregations"))
         .cellValueSynonyms(List.of(CellValueSynonymProperty.builder()
                 .cellValue("cellValue")
                 .synonyms(List.of("synonyms"))
                 .build()))
         .columnDataRole("columnDataRole")
         .columnDescription("columnDescription")
         .columnFriendlyName("columnFriendlyName")
         .columnSynonyms(List.of("columnSynonyms"))
         .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.TopicColumnProperty.Builder

A builder for CfnTopic.TopicColumnProperty

static final class

CfnTopic.TopicColumnProperty.Jsii$Proxy

An implementation for CfnTopic.TopicColumnProperty
Method Summary

Modifier and Type

Method

Description

static CfnTopic.TopicColumnProperty.Builder

builder()

default String

getAggregation()

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

default List<String>

getAllowedAggregations()

The list of aggregation types that are allowed for the column.

default Object

getCellValueSynonyms()

The other names or aliases for the column cell value.

default String

getColumnDataRole()

The role of the column in the data.

default String

getColumnDescription()

A description of the column and its contents.

default String

getColumnFriendlyName()

A user-friendly name for the column.

String

getColumnName()

The name of the column.

default List<String>

getColumnSynonyms()

The other names or aliases for the column.

default Object

getComparativeOrder()

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

default Object

getDefaultFormatting()

The default formatting used for values in the column.

default Object

getDisableIndexing()

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

default Object

getIsIncludedInTopic()

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

default Object

getNeverAggregateInFilter()

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

default Object

getNonAdditive()

The non additive value for the column.

default List<String>

getNotAllowedAggregations()

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

default Object

getSemanticType()

The semantic type of data contained in the column.

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
- getColumnName
  
  @Stability(Stable) @NotNull String getColumnName()
  
  The name of the column.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnname
- getAggregation
  
  @Stability(Stable) @Nullable default String getAggregation()
  
  The type of aggregation that is performed on the column data when it's queried.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-aggregation
- getAllowedAggregations
  
  @Stability(Stable) @Nullable default List<String> getAllowedAggregations()
  
  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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-allowedaggregations
- getCellValueSynonyms
  
  @Stability(Stable) @Nullable default Object getCellValueSynonyms()
  
  The other names or aliases for the column 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-topiccolumn.html#cfn-quicksight-topic-topiccolumn-cellvaluesynonyms
- getColumnDataRole
  
  @Stability(Stable) @Nullable default String getColumnDataRole()
  
  The role of the column in the data.
  Valid values are DIMENSION and MEASURE .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columndatarole
- getColumnDescription
  
  @Stability(Stable) @Nullable default String getColumnDescription()
  
  A description of the column and its contents.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columndescription
- getColumnFriendlyName
  
  @Stability(Stable) @Nullable default String getColumnFriendlyName()
  
  A user-friendly name for the column.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnfriendlyname
- getColumnSynonyms
  
  @Stability(Stable) @Nullable default List<String> getColumnSynonyms()
  
  The other names or aliases for the column.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-columnsynonyms
- getComparativeOrder
  
  @Stability(Stable) @Nullable default Object getComparativeOrder()
  
  The order in which data is displayed for the column 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-topiccolumn.html#cfn-quicksight-topic-topiccolumn-comparativeorder
- getDefaultFormatting
  
  @Stability(Stable) @Nullable default Object getDefaultFormatting()
  
  The default formatting used for values in the column.
  Returns union: either IResolvable or CfnTopic.DefaultFormattingProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-defaultformatting
- getDisableIndexing
  
  @Stability(Stable) @Nullable default Object getDisableIndexing()
  
  A Boolean value that indicates whether the column shows in the autocomplete functionality.
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-disableindexing
- getIsIncludedInTopic
  
  @Stability(Stable) @Nullable default Object getIsIncludedInTopic()
  
  A Boolean value that indicates whether the column is included in the query results.
  Returns union: either Boolean or IResolvable
  Default: - false
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-isincludedintopic
- getNeverAggregateInFilter
  
  @Stability(Stable) @Nullable default Object getNeverAggregateInFilter()
  
  A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
  Returns union: either Boolean or IResolvable
  Default: - false
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-neveraggregateinfilter
- getNonAdditive
  
  @Stability(Stable) @Nullable default Object getNonAdditive()
  
  The non additive value for the column.
  Returns union: either Boolean or IResolvable
  Default: - false
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-nonadditive
- getNotAllowedAggregations
  
  @Stability(Stable) @Nullable default List<String> getNotAllowedAggregations()
  
  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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-notallowedaggregations
- getSemanticType
  
  @Stability(Stable) @Nullable default Object getSemanticType()
  
  The semantic type of data contained in the column.
  Returns union: either IResolvable or CfnTopic.SemanticTypeProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-topic-topiccolumn.html#cfn-quicksight-topic-topiccolumn-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-topiccolumn.html#cfn-quicksight-topic-topiccolumn-timegranularity
- builder
  
  @Stability(Stable) static CfnTopic.TopicColumnProperty.Builder builder()
  
  Returns:
  
  a CfnTopic.TopicColumnProperty.Builder of CfnTopic.TopicColumnProperty

Interface CfnTopic.TopicColumnProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getColumnName

getAggregation

getAllowedAggregations

getCellValueSynonyms

getColumnDataRole

getColumnDescription

getColumnFriendlyName

getColumnSynonyms

getComparativeOrder

getDefaultFormatting

getDisableIndexing

getIsIncludedInTopic

getNeverAggregateInFilter

getNonAdditive

getNotAllowedAggregations

getSemanticType

getTimeGranularity

builder