Class: AWSCDK::QuickSight::CfnTemplate::ForecastComputationProperty

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

Overview

The forecast computation configuration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(computation_id:, custom_seasonality_value: nil, lower_boundary: nil, name: nil, periods_backward: nil, periods_forward: nil, prediction_interval: nil, seasonality: nil, time: nil, upper_boundary: nil, value: nil) ⇒ ForecastComputationProperty

Returns a new instance of ForecastComputationProperty.

Parameters:

  • computation_id (String) —

    The ID for a computation.

  • custom_seasonality_value (Numeric, nil) (defaults to: nil) —

    The custom seasonality value setup of a forecast computation.

  • lower_boundary (Numeric, nil) (defaults to: nil) —

    The lower boundary setup of a forecast computation.

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

    The name of a computation.

  • periods_backward (Numeric, nil) (defaults to: nil) —

    The periods backward setup of a forecast computation.

  • periods_forward (Numeric, nil) (defaults to: nil) —

    The periods forward setup of a forecast computation.

  • prediction_interval (Numeric, nil) (defaults to: nil) —

    The prediction interval setup of a forecast computation.

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

    The seasonality setup of a forecast computation. Choose one of the following options:.

  • time (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::DimensionFieldProperty, nil) (defaults to: nil) —

    The time field that is used in a computation.

  • upper_boundary (Numeric, nil) (defaults to: nil) —

    The upper boundary setup of a forecast computation.

  • value (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::MeasureFieldProperty, nil) (defaults to: nil) —

    The value field that is used in a computation.



10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
 
# File 'quick_sight/cfn_template.rb', line 10907

def initialize(computation_id:, custom_seasonality_value: nil, lower_boundary: nil, name: nil, periods_backward: nil, periods_forward: nil, prediction_interval: nil, seasonality: nil, time: nil, upper_boundary: nil, value: nil)
  @computation_id = computation_id
  Jsii::Type.check_type(@computation_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "computationId")
  @custom_seasonality_value = custom_seasonality_value
  Jsii::Type.check_type(@custom_seasonality_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "customSeasonalityValue") unless @custom_seasonality_value.nil?
  @lower_boundary = lower_boundary
  Jsii::Type.check_type(@lower_boundary, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "lowerBoundary") unless @lower_boundary.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @periods_backward = periods_backward
  Jsii::Type.check_type(@periods_backward, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "periodsBackward") unless @periods_backward.nil?
  @periods_forward = periods_forward
  Jsii::Type.check_type(@periods_forward, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "periodsForward") unless @periods_forward.nil?
  @prediction_interval = prediction_interval
  Jsii::Type.check_type(@prediction_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "predictionInterval") unless @prediction_interval.nil?
  @seasonality = seasonality
  Jsii::Type.check_type(@seasonality, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "seasonality") unless @seasonality.nil?
  @time = time.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DimensionFieldProperty.new(**time.transform_keys(&:to_sym)) : time
  Jsii::Type.check_type(@time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRpbWVuc2lvbkZpZWxkUHJvcGVydHkifV19fQ==")), "time") unless @time.nil?
  @upper_boundary = upper_boundary
  Jsii::Type.check_type(@upper_boundary, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "upperBoundary") unless @upper_boundary.nil?
  @value = value.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::MeasureFieldProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLk1lYXN1cmVGaWVsZFByb3BlcnR5In1dfX0=")), "value") unless @value.nil?
end

Instance Attribute Details

#computation_id ⇒ String (readonly)

The ID for a computation.

Returns:

  • (String)

See Also:



10936
10937
10938
 
# File 'quick_sight/cfn_template.rb', line 10936

def computation_id
  @computation_id
end

#custom_seasonality_value ⇒ Numeric? (readonly)

The custom seasonality value setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



10941
10942
10943
 
# File 'quick_sight/cfn_template.rb', line 10941

def custom_seasonality_value
  @custom_seasonality_value
end

#lower_boundary ⇒ Numeric? (readonly)

The lower boundary setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



10946
10947
10948
 
# File 'quick_sight/cfn_template.rb', line 10946

def lower_boundary
  @lower_boundary
end

#name ⇒ String? (readonly)

The name of a computation.

Returns:

  • (String, nil)

See Also:



10951
10952
10953
 
# File 'quick_sight/cfn_template.rb', line 10951

def name
  @name
end

#periods_backward ⇒ Numeric? (readonly)

The periods backward setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



10956
10957
10958
 
# File 'quick_sight/cfn_template.rb', line 10956

def periods_backward
  @periods_backward
end

#periods_forward ⇒ Numeric? (readonly)

The periods forward setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



10961
10962
10963
 
# File 'quick_sight/cfn_template.rb', line 10961

def periods_forward
  @periods_forward
end

#prediction_interval ⇒ Numeric? (readonly)

The prediction interval setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



10966
10967
10968
 
# File 'quick_sight/cfn_template.rb', line 10966

def prediction_interval
  @prediction_interval
end

#seasonality ⇒ String? (readonly)

The seasonality setup of a forecast computation. Choose one of the following options:.

  • AUTOMATIC
  • CUSTOM : Checks the custom seasonality value.

Returns:

  • (String, nil)

See Also:



10974
10975
10976
 
# File 'quick_sight/cfn_template.rb', line 10974

def seasonality
  @seasonality
end

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

The time field that is used in a computation.

Returns:

See Also:



10979
10980
10981
 
# File 'quick_sight/cfn_template.rb', line 10979

def time
  @time
end

#upper_boundary ⇒ Numeric? (readonly)

The upper boundary setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



10984
10985
10986
 
# File 'quick_sight/cfn_template.rb', line 10984

def upper_boundary
  @upper_boundary
end

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

The value field that is used in a computation.

Returns:

See Also:



10989
10990
10991
 
# File 'quick_sight/cfn_template.rb', line 10989

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
 
# File 'quick_sight/cfn_template.rb', line 10991

def self.jsii_properties
  {
    :computation_id => "computationId",
    :custom_seasonality_value => "customSeasonalityValue",
    :lower_boundary => "lowerBoundary",
    :name => "name",
    :periods_backward => "periodsBackward",
    :periods_forward => "periodsForward",
    :prediction_interval => "predictionInterval",
    :seasonality => "seasonality",
    :time => "time",
    :upper_boundary => "upperBoundary",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
 
# File 'quick_sight/cfn_template.rb', line 11007

def to_jsii
  result = {}
  result.merge!({
    "computationId" => @computation_id,
    "customSeasonalityValue" => @custom_seasonality_value,
    "lowerBoundary" => @lower_boundary,
    "name" => @name,
    "periodsBackward" => @periods_backward,
    "periodsForward" => @periods_forward,
    "predictionInterval" => @prediction_interval,
    "seasonality" => @seasonality,
    "time" => @time,
    "upperBoundary" => @upper_boundary,
    "value" => @value,
  })
  result.compact
end