Class: IntersightClient::ForecastDefinition

Inherits:
MoBaseMo
  • Object
show all
Defined in:
lib/intersight_client/models/forecast_definition.rb

Overview

Definition for forecast metric settings.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from MoBaseMo

#account_moid, #ancestors, #create_time, #display_names, #domain_group_moid, #mod_time, #moid, #owners, #parent, #permission_resources, #shared_scope, #tags, #version_context

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ForecastDefinition

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 128

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `IntersightClient::ForecastDefinition` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `#{self.class.name}`. Please check the name to make sure it's valid. List of attributes: " + self.class.acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'forecast.Definition'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'forecast.Definition'
  end

  if attributes.key?(:'alert_threshold_in_percentage')
    self.alert_threshold_in_percentage = attributes[:'alert_threshold_in_percentage']
  end

  if attributes.key?(:'data_source')
    self.data_source = attributes[:'data_source']
  end

  if attributes.key?(:'metric_name')
    self.metric_name = attributes[:'metric_name']
  end

  if attributes.key?(:'min_num_of_days_of_data')
    self.min_num_of_days_of_data = attributes[:'min_num_of_days_of_data']
  end

  if attributes.key?(:'num_of_days_of_historical_data')
    self.num_of_days_of_historical_data = attributes[:'num_of_days_of_historical_data']
  end

  if attributes.key?(:'platform_type')
    self.platform_type = attributes[:'platform_type']
  end

  if attributes.key?(:'catalog')
    self.catalog = attributes[:'catalog']
  end
end

Instance Attribute Details

#alert_threshold_in_percentage ⇒ Object

Threshold above which user needs to be indicated through alarm/alert.



26
27
28
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 26

def alert_threshold_in_percentage
  @alert_threshold_in_percentage
end

#catalog ⇒ Object

Returns the value of attribute catalog.



43
44
45
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 43

def catalog
  @catalog
end

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 20

def class_id
  @class_id
end

#data_source ⇒ Object

Data source from where we get the data for the metrics to compute regression model. For example Druid.



29
30
31
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 29

def data_source
  @data_source
end

#metric_name ⇒ Object

Metric for which forecast prediction is done. Metrics are defined in the catalog file. Currently its only HyperFlex cluster storage capacity usage.



32
33
34
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 32

def metric_name
  @metric_name
end

#min_num_of_days_of_data ⇒ Object

Minimum number of days of data required for computing forecast model.



35
36
37
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 35

def min_num_of_days_of_data
  @min_num_of_days_of_data
end

#num_of_days_of_historical_data ⇒ Object

Number of days of data queried from the data source (example Druid ) which is used as input data for computing forecast model.



38
39
40
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 38

def num_of_days_of_historical_data
  @num_of_days_of_historical_data
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 23

def object_type
  @object_type
end

#platform_type ⇒ Object

The platform type for which we want to compute forecast. For example HyperFlex, NetworkElement.



41
42
43
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 41

def platform_type
  @platform_type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



88
89
90
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 88

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



83
84
85
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 83

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 68

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'alert_threshold_in_percentage' => :'AlertThresholdInPercentage',
    :'data_source' => :'DataSource',
    :'metric_name' => :'MetricName',
    :'min_num_of_days_of_data' => :'MinNumOfDaysOfData',
    :'num_of_days_of_historical_data' => :'NumOfDaysOfHistoricalData',
    :'platform_type' => :'PlatformType',
    :'catalog' => :'Catalog'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



308
309
310
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 308

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



114
115
116
117
118
119
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 114

def self.openapi_all_of
  [
  :'ForecastDefinitionAllOf',
  :'MoBaseMo'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



122
123
124
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 122

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 108

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 93

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'alert_threshold_in_percentage' => :'Integer',
    :'data_source' => :'String',
    :'metric_name' => :'String',
    :'min_num_of_days_of_data' => :'Integer',
    :'num_of_days_of_historical_data' => :'Integer',
    :'platform_type' => :'String',
    :'catalog' => :'ForecastCatalogRelationship'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      alert_threshold_in_percentage == o.alert_threshold_in_percentage &&
      data_source == o.data_source &&
      metric_name == o.metric_name &&
      min_num_of_days_of_data == o.min_num_of_days_of_data &&
      num_of_days_of_historical_data == o.num_of_days_of_historical_data &&
      platform_type == o.platform_type &&
      catalog == o.catalog && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 339

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 410

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 315

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  ForecastDefinition.openapi_types.each_pair do |key, type|
    if attributes[ForecastDefinition.attribute_map[key]].nil? && ForecastDefinition.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[ForecastDefinition.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[ForecastDefinition.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[ForecastDefinition.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[ForecastDefinition.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


295
296
297
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 301

def hash
  [class_id, object_type, alert_threshold_in_percentage, data_source, metric_name, min_num_of_days_of_data, num_of_days_of_historical_data, platform_type, catalog].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 187

def list_invalid_properties
  invalid_properties = super
  if @class_id.nil?
    invalid_properties.push('invalid value for "class_id", class_id cannot be nil.')
  end

  if @object_type.nil?
    invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
  end

  if !@alert_threshold_in_percentage.nil? && @alert_threshold_in_percentage < 1
    invalid_properties.push('invalid value for "alert_threshold_in_percentage", must be greater than or equal to 1.')
  end

  if !@min_num_of_days_of_data.nil? && @min_num_of_days_of_data < 3
    invalid_properties.push('invalid value for "min_num_of_days_of_data", must be greater than or equal to 3.')
  end

  if !@num_of_days_of_historical_data.nil? && @num_of_days_of_historical_data < 14
    invalid_properties.push('invalid value for "num_of_days_of_historical_data", must be greater than or equal to 14.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



386
387
388
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 386

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 392

def to_hash
  hash = super
  ForecastDefinition.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = ForecastDefinition.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



380
381
382
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 380

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/intersight_client/models/forecast_definition.rb', line 214

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["forecast.Definition"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["forecast.Definition"])
  return false unless object_type_validator.valid?(@object_type)
  return false if !@alert_threshold_in_percentage.nil? && @alert_threshold_in_percentage < 1
  return false if !@min_num_of_days_of_data.nil? && @min_num_of_days_of_data < 3
  return false if !@num_of_days_of_historical_data.nil? && @num_of_days_of_historical_data < 14
  true && super
end