Class: Falcon::MlscannerapiQuota

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MlscannerapiQuota

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 72

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::MlscannerapiQuota` 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::MlscannerapiQuota`. 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?(:'in_progress')
    self.in_progress = attributes[:'in_progress']
  end

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

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

Instance Attribute Details

#in_progressObject

Returns the value of attribute in_progress.


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

def in_progress
  @in_progress
end

#totalObject

Returns the value of attribute total.


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

def total
  @total
end

#usedObject

Returns the value of attribute used.


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

def used
  @used
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about

[View source]

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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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

[View source]

42
43
44
45
46
47
48
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 42

def self.attribute_map
  {
    :'in_progress' => :'in_progress',
    :'total' => :'total',
    :'used' => :'used'
  }
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

[View source]

151
152
153
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 151

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

.openapi_nullableObject

List of attributes with nullable: true

[View source]

65
66
67
68
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 65

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

.openapi_typesObject

Attribute type mapping.

[View source]

56
57
58
59
60
61
62
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 56

def self.openapi_types
  {
    :'in_progress' => :'Integer',
    :'total' => :'Integer',
    :'used' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared

[View source]

128
129
130
131
132
133
134
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      in_progress == o.in_progress &&
      total == o.total &&
      used == o.used
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

[View source]

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 182

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

[View source]

253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 253

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

[View source]

158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 158

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
[View source]

138
139
140
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 138

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code

[View source]

144
145
146
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 144

def hash
  [in_progress, total, used].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons

[View source]

100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 100

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash

[View source]

229
230
231
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 229

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash

[View source]

235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 235

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object

[View source]

223
224
225
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 223

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

[View source]

119
120
121
122
123
124
# File 'lib/crimson-falcon/models/mlscannerapi_quota.rb', line 119

def valid?
  return false if @in_progress.nil?
  return false if @total.nil?
  return false if @used.nil?
  true
end