Class: Falcon::V2Definition

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/models/v2_definition.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2Definition

Initializes the object

Parameters:

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

    Model attributes in the form of hash


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
184
185
186
187
188
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 112

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::V2Definition` 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.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Falcon::V2Definition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'actions')
    if (value = attributes[:'actions']).is_a?(Hash)
      self.actions = value
    end
  end

  if attributes.key?(:'conditions')
    if (value = attributes[:'conditions']).is_a?(Hash)
      self.conditions = value
    end
  end

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

  if attributes.key?(:'labels')
    if (value = attributes[:'labels']).is_a?(Array)
      self.labels = value
    end
  end

  if attributes.key?(:'loops')
    if (value = attributes[:'loops']).is_a?(Hash)
      self.loops = value
    end
  end

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

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

  if attributes.key?(:'node_registry')
    if (value = attributes[:'node_registry']).is_a?(Hash)
      self.node_registry = value
    end
  end

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

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

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

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

  if attributes.key?(:'uniq_node_seen')
    if (value = attributes[:'uniq_node_seen']).is_a?(Hash)
      self.uniq_node_seen = value
    end
  end
end

Instance Attribute Details

#actions ⇒ Object

Returns the value of attribute actions.


35
36
37
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 35

def actions
  @actions
end

#conditions ⇒ Object

Returns the value of attribute conditions.


37
38
39
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 37

def conditions
  @conditions
end

#description ⇒ Object

Returns the value of attribute description.


39
40
41
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 39

def description
  @description
end

#labels ⇒ Object

Returns the value of attribute labels.


41
42
43
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 41

def labels
  @labels
end

#loops ⇒ Object

Returns the value of attribute loops.


43
44
45
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 43

def loops
  @loops
end

#multi_instance ⇒ Object

Returns the value of attribute multi_instance.


45
46
47
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 45

def multi_instance
  @multi_instance
end

#name ⇒ Object

Returns the value of attribute name.


47
48
49
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 47

def name
  @name
end

#node_registry ⇒ Object

Returns the value of attribute node_registry.


49
50
51
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 49

def node_registry
  @node_registry
end

#parameters ⇒ Object

Returns the value of attribute parameters.


51
52
53
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 51

def parameters
  @parameters
end

#provision_on_install ⇒ Object

Returns the value of attribute provision_on_install.


53
54
55
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 53

def provision_on_install
  @provision_on_install
end

#trigger ⇒ Object

Returns the value of attribute trigger.


55
56
57
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 55

def trigger
  @trigger
end

#type ⇒ Object

Returns the value of attribute type.


57
58
59
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 57

def type
  @type
end

#uniq_node_seen ⇒ Object

Returns the value of attribute uniq_node_seen.


59
60
61
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 59

def uniq_node_seen
  @uniq_node_seen
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about


81
82
83
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 62

def self.attribute_map
  {
    :'actions' => :'actions',
    :'conditions' => :'conditions',
    :'description' => :'description',
    :'labels' => :'labels',
    :'loops' => :'loops',
    :'multi_instance' => :'multi_instance',
    :'name' => :'name',
    :'node_registry' => :'nodeRegistry',
    :'parameters' => :'parameters',
    :'provision_on_install' => :'provision_on_install',
    :'trigger' => :'trigger',
    :'type' => :'type',
    :'uniq_node_seen' => :'uniqNodeSeen'
  }
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


258
259
260
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true


105
106
107
108
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 86

def self.openapi_types
  {
    :'actions' => :'Hash<String, V2Activity>',
    :'conditions' => :'Hash<String, V2Condition>',
    :'description' => :'String',
    :'labels' => :'Array<String>',
    :'loops' => :'Hash<String, V2Loop>',
    :'multi_instance' => :'Boolean',
    :'name' => :'String',
    :'node_registry' => :'Hash<String, String>',
    :'parameters' => :'V2Parameters',
    :'provision_on_install' => :'Boolean',
    :'trigger' => :'V2Trigger',
    :'type' => :'String',
    :'uniq_node_seen' => :'Hash<String, Boolean>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      actions == o.actions &&
      conditions == o.conditions &&
      description == o.description &&
      labels == o.labels &&
      loops == o.loops &&
      multi_instance == o.multi_instance &&
      name == o.name &&
      node_registry == o.node_registry &&
      parameters == o.parameters &&
      provision_on_install == o.provision_on_install &&
      trigger == o.trigger &&
      type == o.type &&
      uniq_node_seen == o.uniq_node_seen
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


289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 289

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 = Falcon.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


360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 360

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


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 265

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

245
246
247
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code


251
252
253
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 251

def hash
  [actions, conditions, description, labels, loops, multi_instance, name, node_registry, parameters, provision_on_install, trigger, type, uniq_node_seen].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


192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 192

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

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

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

  if @uniq_node_seen.nil?
    invalid_properties.push('invalid value for "uniq_node_seen", uniq_node_seen cannot be nil.')
  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


336
337
338
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 336

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


342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 342

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.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


330
331
332
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 330

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


215
216
217
218
219
220
221
 
# File 'lib/crimson-falcon/models/v2_definition.rb', line 215

def valid?
  return false if @name.nil?
  return false if @node_registry.nil?
  return false if @trigger.nil?
  return false if @uniq_node_seen.nil?
  true
end