Class: AWSCDK::QuickSight::CfnTopic::TopicRelativeDateFilterProperty

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

Overview

A structure that represents a relative date filter.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(constant: nil, relative_date_filter_function: nil, time_granularity: nil) ⇒ TopicRelativeDateFilterProperty

Returns a new instance of TopicRelativeDateFilterProperty.

Parameters:

  • constant (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTopic::TopicSingularFilterConstantProperty, nil) (defaults to: nil) —

    The constant used in a relative date filter.

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

    The function to be used in a relative date filter to determine the range of dates to include in the results.

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

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



2459
2460
2461
2462
2463
2464
2465
2466
 
# File 'quick_sight/cfn_topic.rb', line 2459

def initialize(constant: nil, relative_date_filter_function: nil, time_granularity: nil)
  @constant = constant.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTopic::TopicSingularFilterConstantProperty.new(**constant.transform_keys(&:to_sym)) : constant
  Jsii::Type.check_type(@constant, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRvcGljLlRvcGljU2luZ3VsYXJGaWx0ZXJDb25zdGFudFByb3BlcnR5In1dfX0=")), "constant") unless @constant.nil?
  @relative_date_filter_function = relative_date_filter_function
  Jsii::Type.check_type(@relative_date_filter_function, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "relativeDateFilterFunction") unless @relative_date_filter_function.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

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

The constant used in a relative date filter.

Returns:

See Also:



2472
2473
2474
 
# File 'quick_sight/cfn_topic.rb', line 2472

def constant
  @constant
end

#relative_date_filter_function ⇒ String? (readonly)

The function to be used in a relative date filter to determine the range of dates to include in the results.

Valid values for this structure are BEFORE , AFTER , and BETWEEN .

Returns:

  • (String, nil)

See Also:



2479
2480
2481
 
# File 'quick_sight/cfn_topic.rb', line 2479

def relative_date_filter_function
  @relative_date_filter_function
end

#time_granularity ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



2484
2485
2486
 
# File 'quick_sight/cfn_topic.rb', line 2484

def time_granularity
  @time_granularity
end

Class Method Details

.jsii_properties ⇒ Object 



2486
2487
2488
2489
2490
2491
2492
 
# File 'quick_sight/cfn_topic.rb', line 2486

def self.jsii_properties
  {
    :constant => "constant",
    :relative_date_filter_function => "relativeDateFilterFunction",
    :time_granularity => "timeGranularity",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2494
2495
2496
2497
2498
2499
2500
2501
2502
 
# File 'quick_sight/cfn_topic.rb', line 2494

def to_jsii
  result = {}
  result.merge!({
    "constant" => @constant,
    "relativeDateFilterFunction" => @relative_date_filter_function,
    "timeGranularity" => @time_granularity,
  })
  result.compact
end