Class: AWSCDK::QuickSight::CfnDashboard::ForecastComputationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.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::CfnDashboard::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::CfnDashboard::MeasureFieldProperty, nil) (defaults to: nil) —

    The value field that is used in a computation.



11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
 
# File 'quick_sight/cfn_dashboard.rb', line 11852

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::CfnDashboard::DimensionFieldProperty.new(**time.transform_keys(&:to_sym)) : time
  Jsii::Type.check_type(@time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EaW1lbnNpb25GaWVsZFByb3BlcnR5In1dfX0=")), "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::CfnDashboard::MeasureFieldProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5NZWFzdXJlRmllbGRQcm9wZXJ0eSJ9XX19")), "value") unless @value.nil?
end

Instance Attribute Details

#computation_id ⇒ String (readonly)

The ID for a computation.

Returns:

  • (String)

See Also:



11881
11882
11883
 
# File 'quick_sight/cfn_dashboard.rb', line 11881

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:



11886
11887
11888
 
# File 'quick_sight/cfn_dashboard.rb', line 11886

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:



11891
11892
11893
 
# File 'quick_sight/cfn_dashboard.rb', line 11891

def lower_boundary
  @lower_boundary
end

#name ⇒ String? (readonly)

The name of a computation.

Returns:

  • (String, nil)

See Also:



11896
11897
11898
 
# File 'quick_sight/cfn_dashboard.rb', line 11896

def name
  @name
end

#periods_backward ⇒ Numeric? (readonly)

The periods backward setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



11901
11902
11903
 
# File 'quick_sight/cfn_dashboard.rb', line 11901

def periods_backward
  @periods_backward
end

#periods_forward ⇒ Numeric? (readonly)

The periods forward setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



11906
11907
11908
 
# File 'quick_sight/cfn_dashboard.rb', line 11906

def periods_forward
  @periods_forward
end

#prediction_interval ⇒ Numeric? (readonly)

The prediction interval setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



11911
11912
11913
 
# File 'quick_sight/cfn_dashboard.rb', line 11911

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:



11919
11920
11921
 
# File 'quick_sight/cfn_dashboard.rb', line 11919

def seasonality
  @seasonality
end

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

The time field that is used in a computation.

Returns:

See Also:



11924
11925
11926
 
# File 'quick_sight/cfn_dashboard.rb', line 11924

def time
  @time
end

#upper_boundary ⇒ Numeric? (readonly)

The upper boundary setup of a forecast computation.

Returns:

  • (Numeric, nil)

See Also:



11929
11930
11931
 
# File 'quick_sight/cfn_dashboard.rb', line 11929

def upper_boundary
  @upper_boundary
end

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

The value field that is used in a computation.

Returns:

See Also:



11934
11935
11936
 
# File 'quick_sight/cfn_dashboard.rb', line 11934

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
 
# File 'quick_sight/cfn_dashboard.rb', line 11936

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 



11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
 
# File 'quick_sight/cfn_dashboard.rb', line 11952

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