Class: MistApi::ConstInsightMetricsPropertyParam

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/mist_api/models/const_insight_metrics_property_param.rb

Overview

ConstInsightMetricsPropertyParam Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(required = SKIP) ⇒ ConstInsightMetricsPropertyParam

Returns a new instance of ConstInsightMetricsPropertyParam.



35
36
37
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 35

def initialize(required = SKIP)
  @required = required unless required == SKIP
end

Instance Attribute Details

#required ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


14
15
16
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 14

def required
  @required
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



40
41
42
43
44
45
46
47
48
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 40

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  required = hash.key?('required') ? hash['required'] : SKIP

  # Create object from extracted values.
  ConstInsightMetricsPropertyParam.new(required)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 17

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['required'] = 'required'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



31
32
33
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 31

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



24
25
26
27
28
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 24

def self.optionals
  %w[
    required
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



52
53
54
55
56
57
58
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 52

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



67
68
69
70
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 67

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} required: #{@required.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



61
62
63
64
 
# File 'lib/mist_api/models/const_insight_metrics_property_param.rb', line 61

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} required: #{@required}>"
end