Class: AWSCDK::QuickSight::CfnAnalysis::TimeRangeFilterProperty

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

Overview

A TimeRangeFilter filters values that are between two specified values.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(column:, filter_id:, null_option:, default_filter_control_configuration: nil, exclude_period_configuration: nil, include_maximum: nil, include_minimum: nil, range_maximum_value: nil, range_minimum_value: nil, time_granularity: nil) ⇒ TimeRangeFilterProperty

Returns a new instance of TimeRangeFilterProperty.

Parameters:



29529
29530
29531
29532
29533
29534
29535
29536
29537
29538
29539
29540
29541
29542
29543
29544
29545
29546
29547
29548
29549
29550
 
# File 'quick_sight/cfn_analysis.rb', line 29529

def initialize(column:, filter_id:, null_option:, default_filter_control_configuration: nil, exclude_period_configuration: nil, include_maximum: nil, include_minimum: nil, range_maximum_value: nil, range_minimum_value: nil, time_granularity: nil)
  @column = column.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ColumnIdentifierProperty.new(**column.transform_keys(&:to_sym)) : column
  Jsii::Type.check_type(@column, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkNvbHVtbklkZW50aWZpZXJQcm9wZXJ0eSJ9XX19")), "column")
  @filter_id = filter_id
  Jsii::Type.check_type(@filter_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterId")
  @null_option = null_option
  Jsii::Type.check_type(@null_option, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nullOption")
  @default_filter_control_configuration = default_filter_control_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::DefaultFilterControlConfigurationProperty.new(**default_filter_control_configuration.transform_keys(&:to_sym)) : default_filter_control_configuration
  Jsii::Type.check_type(@default_filter_control_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkRlZmF1bHRGaWx0ZXJDb250cm9sQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "defaultFilterControlConfiguration") unless @default_filter_control_configuration.nil?
  @exclude_period_configuration = exclude_period_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::ExcludePeriodConfigurationProperty.new(**exclude_period_configuration.transform_keys(&:to_sym)) : exclude_period_configuration
  Jsii::Type.check_type(@exclude_period_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLkV4Y2x1ZGVQZXJpb2RDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "excludePeriodConfiguration") unless @exclude_period_configuration.nil?
  @include_maximum = include_maximum
  Jsii::Type.check_type(@include_maximum, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "includeMaximum") unless @include_maximum.nil?
  @include_minimum = include_minimum
  Jsii::Type.check_type(@include_minimum, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "includeMinimum") unless @include_minimum.nil?
  @range_maximum_value = range_maximum_value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TimeRangeFilterValueProperty.new(**range_maximum_value.transform_keys(&:to_sym)) : range_maximum_value
  Jsii::Type.check_type(@range_maximum_value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRpbWVSYW5nZUZpbHRlclZhbHVlUHJvcGVydHkifV19fQ==")), "rangeMaximumValue") unless @range_maximum_value.nil?
  @range_minimum_value = range_minimum_value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnAnalysis::TimeRangeFilterValueProperty.new(**range_minimum_value.transform_keys(&:to_sym)) : range_minimum_value
  Jsii::Type.check_type(@range_minimum_value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkFuYWx5c2lzLlRpbWVSYW5nZUZpbHRlclZhbHVlUHJvcGVydHkifV19fQ==")), "rangeMinimumValue") unless @range_minimum_value.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

#column ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnAnalysis::ColumnIdentifierProperty (readonly)

The column that the filter is applied to.

Returns:

See Also:



29556
29557
29558
 
# File 'quick_sight/cfn_analysis.rb', line 29556

def column
  @column
end

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

The default configurations for the associated controls.

This applies only for filters that are scoped to multiple sheets.

Returns:

See Also:



29577
29578
29579
 
# File 'quick_sight/cfn_analysis.rb', line 29577

def default_filter_control_configuration
  @default_filter_control_configuration
end

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

The exclude period of the time range filter.

Returns:

See Also:



29582
29583
29584
 
# File 'quick_sight/cfn_analysis.rb', line 29582

def exclude_period_configuration
  @exclude_period_configuration
end

#filter_id ⇒ String (readonly)

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

Returns:

  • (String)

See Also:



29561
29562
29563
 
# File 'quick_sight/cfn_analysis.rb', line 29561

def filter_id
  @filter_id
end

#include_maximum ⇒ Boolean, ... (readonly)

Determines whether the maximum value in the filter value range should be included in the filtered results.

Returns:

See Also:



29587
29588
29589
 
# File 'quick_sight/cfn_analysis.rb', line 29587

def include_maximum
  @include_maximum
end

#include_minimum ⇒ Boolean, ... (readonly)

Determines whether the minimum value in the filter value range should be included in the filtered results.

Returns:

See Also:



29592
29593
29594
 
# File 'quick_sight/cfn_analysis.rb', line 29592

def include_minimum
  @include_minimum
end

#null_option ⇒ String (readonly)

This option determines how null values should be treated when filtering data.

  • ALL_VALUES : Include null values in filtered results.
  • NULLS_ONLY : Only include null values in filtered results.
  • NON_NULLS_ONLY : Exclude null values from filtered results.

Returns:

  • (String)

See Also:



29570
29571
29572
 
# File 'quick_sight/cfn_analysis.rb', line 29570

def null_option
  @null_option
end

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

The maximum value for the filter value range.

Returns:

See Also:



29597
29598
29599
 
# File 'quick_sight/cfn_analysis.rb', line 29597

def range_maximum_value
  @range_maximum_value
end

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

The minimum value for the filter value range.

Returns:

See Also:



29602
29603
29604
 
# File 'quick_sight/cfn_analysis.rb', line 29602

def range_minimum_value
  @range_minimum_value
end

#time_granularity ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



29607
29608
29609
 
# File 'quick_sight/cfn_analysis.rb', line 29607

def time_granularity
  @time_granularity
end

Class Method Details

.jsii_properties ⇒ Object 



29609
29610
29611
29612
29613
29614
29615
29616
29617
29618
29619
29620
29621
29622
 
# File 'quick_sight/cfn_analysis.rb', line 29609

def self.jsii_properties
  {
    :column => "column",
    :filter_id => "filterId",
    :null_option => "nullOption",
    :default_filter_control_configuration => "defaultFilterControlConfiguration",
    :exclude_period_configuration => "excludePeriodConfiguration",
    :include_maximum => "includeMaximum",
    :include_minimum => "includeMinimum",
    :range_maximum_value => "rangeMaximumValue",
    :range_minimum_value => "rangeMinimumValue",
    :time_granularity => "timeGranularity",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



29624
29625
29626
29627
29628
29629
29630
29631
29632
29633
29634
29635
29636
29637
29638
29639
 
# File 'quick_sight/cfn_analysis.rb', line 29624

def to_jsii
  result = {}
  result.merge!({
    "column" => @column,
    "filterId" => @filter_id,
    "nullOption" => @null_option,
    "defaultFilterControlConfiguration" => @default_filter_control_configuration,
    "excludePeriodConfiguration" => @exclude_period_configuration,
    "includeMaximum" => @include_maximum,
    "includeMinimum" => @include_minimum,
    "rangeMaximumValue" => @range_maximum_value,
    "rangeMinimumValue" => @range_minimum_value,
    "timeGranularity" => @time_granularity,
  })
  result.compact
end