Class: AWSCDK::QuickSight::CfnAnalysis::WhatIfRangeScenarioProperty

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

Overview

Provides the forecast to meet the target for a particular date range.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(end_date:, start_date:, value:) ⇒ WhatIfRangeScenarioProperty

Returns a new instance of WhatIfRangeScenarioProperty.

Parameters:

  • end_date (String) —

    The end date in the date range that you need the forecast results for.

  • start_date (String) —

    The start date in the date range that you need the forecast results for.

  • value (Numeric) —

    The target value that you want to meet for the provided date range.



32135
32136
32137
32138
32139
32140
32141
32142
 
# File 'quick_sight/cfn_analysis.rb', line 32135

def initialize(end_date:, start_date:, value:)
  @end_date = end_date
  Jsii::Type.check_type(@end_date, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endDate")
  @start_date = start_date
  Jsii::Type.check_type(@start_date, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startDate")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "value")
end

Instance Attribute Details

#end_date ⇒ String (readonly)

The end date in the date range that you need the forecast results for.

Returns:

  • (String)

See Also:



32148
32149
32150
 
# File 'quick_sight/cfn_analysis.rb', line 32148

def end_date
  @end_date
end

#start_date ⇒ String (readonly)

The start date in the date range that you need the forecast results for.

Returns:

  • (String)

See Also:



32153
32154
32155
 
# File 'quick_sight/cfn_analysis.rb', line 32153

def start_date
  @start_date
end

#value ⇒ Numeric (readonly)

Note:

Default: - 0

The target value that you want to meet for the provided date range.

Returns:

  • (Numeric)

See Also:



32159
32160
32161
 
# File 'quick_sight/cfn_analysis.rb', line 32159

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



32161
32162
32163
32164
32165
32166
32167
 
# File 'quick_sight/cfn_analysis.rb', line 32161

def self.jsii_properties
  {
    :end_date => "endDate",
    :start_date => "startDate",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



32169
32170
32171
32172
32173
32174
32175
32176
32177
 
# File 'quick_sight/cfn_analysis.rb', line 32169

def to_jsii
  result = {}
  result.merge!({
    "endDate" => @end_date,
    "startDate" => @start_date,
    "value" => @value,
  })
  result.compact
end