Class: AWSCDK::QuickSight::CfnTopic::TopicColumnProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_topic.rb

Overview

Represents a column in a dataset.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(column_name:, aggregation: nil, allowed_aggregations: nil, cell_value_synonyms: nil, column_data_role: nil, column_description: nil, column_friendly_name: nil, column_synonyms: nil, comparative_order: nil, default_formatting: nil, disable_indexing: nil, is_included_in_topic: nil, never_aggregate_in_filter: nil, non_additive: nil, not_allowed_aggregations: nil, semantic_type: nil, time_granularity: nil) ⇒ TopicColumnProperty

Returns a new instance of TopicColumnProperty.

Parameters:

  • column_name (String) —

    The name of the column.

  • aggregation (String, nil) (defaults to: nil) —

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

  • allowed_aggregations (Array<String>, nil) (defaults to: nil) —

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

  • cell_value_synonyms (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::CellValueSynonymProperty>, nil) (defaults to: nil) —

    The other names or aliases for the column cell value.

  • column_data_role (String, nil) (defaults to: nil) —

    The role of the column in the data.

  • column_description (String, nil) (defaults to: nil) —

    A description of the column and its contents.

  • column_friendly_name (String, nil) (defaults to: nil) —

    A user-friendly name for the column.

  • column_synonyms (Array<String>, nil) (defaults to: nil) —

    The other names or aliases for the column.

  • comparative_order (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::ComparativeOrderProperty, nil) (defaults to: nil) —

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

  • default_formatting (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::DefaultFormattingProperty, nil) (defaults to: nil) —

    The default formatting used for values in the column.

  • disable_indexing (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • is_included_in_topic (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • never_aggregate_in_filter (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • non_additive (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    The non additive value for the column.

  • not_allowed_aggregations (Array<String>, nil) (defaults to: nil) —

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

  • semantic_type (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::SemanticTypeProperty, nil) (defaults to: nil) —

    The semantic type of data contained in the column.

  • time_granularity (String, nil) (defaults to: nil) —

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



1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'quick_sight/cfn_topic.rb', line 1832

def initialize(column_name:, aggregation: nil, allowed_aggregations: nil, cell_value_synonyms: nil, column_data_role: nil, column_description: nil, column_friendly_name: nil, column_synonyms: nil, comparative_order: nil, default_formatting: nil, disable_indexing: nil, is_included_in_topic: nil, never_aggregate_in_filter: nil, non_additive: nil, not_allowed_aggregations: nil, semantic_type: nil, time_granularity: nil)
  @column_name = column_name
  Jsii::Type.check_type(@column_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "columnName")
  @aggregation = aggregation
  Jsii::Type.check_type(@aggregation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aggregation") unless @aggregation.nil?
  @allowed_aggregations = allowed_aggregations
  Jsii::Type.check_type(@allowed_aggregations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "allowedAggregations") unless @allowed_aggregations.nil?
  @cell_value_synonyms = cell_value_synonyms
  Jsii::Type.check_type(@cell_value_synonyms, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5Ub3BpYy5DZWxsVmFsdWVTeW5vbnltUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "cellValueSynonyms") unless @cell_value_synonyms.nil?
  @column_data_role = column_data_role
  Jsii::Type.check_type(@column_data_role, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "columnDataRole") unless @column_data_role.nil?
  @column_description = column_description
  Jsii::Type.check_type(@column_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "columnDescription") unless @column_description.nil?
  @column_friendly_name = column_friendly_name
  Jsii::Type.check_type(@column_friendly_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "columnFriendlyName") unless @column_friendly_name.nil?
  @column_synonyms = column_synonyms
  Jsii::Type.check_type(@column_synonyms, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "columnSynonyms") unless @column_synonyms.nil?
  @comparative_order = comparative_order.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::ComparativeOrderProperty.new(**comparative_order.transform_keys(&:to_sym)) : comparative_order
  Jsii::Type.check_type(@comparative_order, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLkNvbXBhcmF0aXZlT3JkZXJQcm9wZXJ0eSJ9XX19")), "comparativeOrder") unless @comparative_order.nil?
  @default_formatting = default_formatting.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::DefaultFormattingProperty.new(**default_formatting.transform_keys(&:to_sym)) : default_formatting
  Jsii::Type.check_type(@default_formatting, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLkRlZmF1bHRGb3JtYXR0aW5nUHJvcGVydHkifV19fQ==")), "defaultFormatting") unless @default_formatting.nil?
  @disable_indexing = disable_indexing
  Jsii::Type.check_type(@disable_indexing, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableIndexing") unless @disable_indexing.nil?
  @is_included_in_topic = is_included_in_topic
  Jsii::Type.check_type(@is_included_in_topic, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isIncludedInTopic") unless @is_included_in_topic.nil?
  @never_aggregate_in_filter = never_aggregate_in_filter
  Jsii::Type.check_type(@never_aggregate_in_filter, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "neverAggregateInFilter") unless @never_aggregate_in_filter.nil?
  @non_additive = non_additive
  Jsii::Type.check_type(@non_additive, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "nonAdditive") unless @non_additive.nil?
  @not_allowed_aggregations = not_allowed_aggregations
  Jsii::Type.check_type(@not_allowed_aggregations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "notAllowedAggregations") unless @not_allowed_aggregations.nil?
  @semantic_type = semantic_type.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::SemanticTypeProperty.new(**semantic_type.transform_keys(&:to_sym)) : semantic_type
  Jsii::Type.check_type(@semantic_type, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlNlbWFudGljVHlwZVByb3BlcnR5In1dfX0=")), "semanticType") unless @semantic_type.nil?
  @time_granularity = time_granularity
  Jsii::Type.check_type(@time_granularity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeGranularity") unless @time_granularity.nil?
end

Instance Attribute Details

#aggregation ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1878
1879
1880
 
# File 'quick_sight/cfn_topic.rb', line 1878

def aggregation
  @aggregation
end

#allowed_aggregations ⇒ Array<String>? (readonly)

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 .

Returns:

  • (Array<String>, nil)

See Also:



1885
1886
1887
 
# File 'quick_sight/cfn_topic.rb', line 1885

def allowed_aggregations
  @allowed_aggregations
end

#cell_value_synonyms ⇒ AWSCDK::IResolvable, ... (readonly)

The other names or aliases for the column cell value.

Returns:

See Also:



1890
1891
1892
 
# File 'quick_sight/cfn_topic.rb', line 1890

def cell_value_synonyms
  @cell_value_synonyms
end

#column_data_role ⇒ String? (readonly)

The role of the column in the data.

Valid values are DIMENSION and MEASURE .

Returns:

  • (String, nil)

See Also:



1897
1898
1899
 
# File 'quick_sight/cfn_topic.rb', line 1897

def column_data_role
  @column_data_role
end

#column_description ⇒ String? (readonly)

A description of the column and its contents.

Returns:

  • (String, nil)

See Also:



1902
1903
1904
 
# File 'quick_sight/cfn_topic.rb', line 1902

def column_description
  @column_description
end

#column_friendly_name ⇒ String? (readonly)

A user-friendly name for the column.

Returns:

  • (String, nil)

See Also:



1907
1908
1909
 
# File 'quick_sight/cfn_topic.rb', line 1907

def column_friendly_name
  @column_friendly_name
end

#column_name ⇒ String (readonly)

The name of the column.

Returns:

  • (String)

See Also:



1873
1874
1875
 
# File 'quick_sight/cfn_topic.rb', line 1873

def column_name
  @column_name
end

#column_synonyms ⇒ Array<String>? (readonly)

The other names or aliases for the column.

Returns:

  • (Array<String>, nil)

See Also:



1912
1913
1914
 
# File 'quick_sight/cfn_topic.rb', line 1912

def column_synonyms
  @column_synonyms
end

#comparative_order ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



1917
1918
1919
 
# File 'quick_sight/cfn_topic.rb', line 1917

def comparative_order
  @comparative_order
end

#default_formatting ⇒ AWSCDK::IResolvable, ... (readonly)

The default formatting used for values in the column.

Returns:

See Also:



1922
1923
1924
 
# File 'quick_sight/cfn_topic.rb', line 1922

def default_formatting
  @default_formatting
end

#disable_indexing ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



1927
1928
1929
 
# File 'quick_sight/cfn_topic.rb', line 1927

def disable_indexing
  @disable_indexing
end

#is_included_in_topic ⇒ Boolean, ... (readonly)

Note:

Default: - false

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

Returns:

See Also:



1933
1934
1935
 
# File 'quick_sight/cfn_topic.rb', line 1933

def is_included_in_topic
  @is_included_in_topic
end

#never_aggregate_in_filter ⇒ Boolean, ... (readonly)

Note:

Default: - false

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

Returns:

See Also:



1939
1940
1941
 
# File 'quick_sight/cfn_topic.rb', line 1939

def never_aggregate_in_filter
  @never_aggregate_in_filter
end

#non_additive ⇒ Boolean, ... (readonly)

Note:

Default: - false

The non additive value for the column.

Returns:

See Also:



1945
1946
1947
 
# File 'quick_sight/cfn_topic.rb', line 1945

def non_additive
  @non_additive
end

#not_allowed_aggregations ⇒ Array<String>? (readonly)

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 .

Returns:

  • (Array<String>, nil)

See Also:



1952
1953
1954
 
# File 'quick_sight/cfn_topic.rb', line 1952

def not_allowed_aggregations
  @not_allowed_aggregations
end

#semantic_type ⇒ AWSCDK::IResolvable, ... (readonly)

The semantic type of data contained in the column.

Returns:

See Also:



1957
1958
1959
 
# File 'quick_sight/cfn_topic.rb', line 1957

def semantic_type
  @semantic_type
end

#time_granularity ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1962
1963
1964
 
# File 'quick_sight/cfn_topic.rb', line 1962

def time_granularity
  @time_granularity
end

Class Method Details

.jsii_properties ⇒ Object 



1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
 
# File 'quick_sight/cfn_topic.rb', line 1964

def self.jsii_properties
  {
    :column_name => "columnName",
    :aggregation => "aggregation",
    :allowed_aggregations => "allowedAggregations",
    :cell_value_synonyms => "cellValueSynonyms",
    :column_data_role => "columnDataRole",
    :column_description => "columnDescription",
    :column_friendly_name => "columnFriendlyName",
    :column_synonyms => "columnSynonyms",
    :comparative_order => "comparativeOrder",
    :default_formatting => "defaultFormatting",
    :disable_indexing => "disableIndexing",
    :is_included_in_topic => "isIncludedInTopic",
    :never_aggregate_in_filter => "neverAggregateInFilter",
    :non_additive => "nonAdditive",
    :not_allowed_aggregations => "notAllowedAggregations",
    :semantic_type => "semanticType",
    :time_granularity => "timeGranularity",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
 
# File 'quick_sight/cfn_topic.rb', line 1986

def to_jsii
  result = {}
  result.merge!({
    "columnName" => @column_name,
    "aggregation" => @aggregation,
    "allowedAggregations" => @allowed_aggregations,
    "cellValueSynonyms" => @cell_value_synonyms,
    "columnDataRole" => @column_data_role,
    "columnDescription" => @column_description,
    "columnFriendlyName" => @column_friendly_name,
    "columnSynonyms" => @column_synonyms,
    "comparativeOrder" => @comparative_order,
    "defaultFormatting" => @default_formatting,
    "disableIndexing" => @disable_indexing,
    "isIncludedInTopic" => @is_included_in_topic,
    "neverAggregateInFilter" => @never_aggregate_in_filter,
    "nonAdditive" => @non_additive,
    "notAllowedAggregations" => @not_allowed_aggregations,
    "semanticType" => @semantic_type,
    "timeGranularity" => @time_granularity,
  })
  result.compact
end