Class: FeratelCheckApiClient::ServiceUsage

Inherits:
Object
  • Object
show all
Defined in:
lib/feratel-check-api-client/models/service_usage.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ServiceUsage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
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
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 105

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_exitObject

Returns the value of attribute auto_exit.



18
19
20
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 18

def auto_exit
  @auto_exit
end

#auto_exit_intervalObject

Returns the value of attribute auto_exit_interval.



20
21
22
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 20

def auto_exit_interval
  @auto_exit_interval
end

#count_mObject

Returns the value of attribute count_m.



24
25
26
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 24

def count_m
  @count_m
end

#count_nObject

Returns the value of attribute count_n.



22
23
24
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 22

def count_n
  @count_n
end

#double_use_timeoutObject

Returns the value of attribute double_use_timeout.



26
27
28
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 26

def double_use_timeout
  @double_use_timeout
end

#from_dateObject

Returns the value of attribute from_date.



28
29
30
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 28

def from_date
  @from_date
end

#not_usable_on_first_or_last_dayObject

Returns the value of attribute not_usable_on_first_or_last_day.



30
31
32
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 30

def not_usable_on_first_or_last_day
  @not_usable_on_first_or_last_day
end

#to_dateObject

Returns the value of attribute to_date.



32
33
34
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 32

def to_date
  @to_date
end

#typeObject

Returns the value of attribute type.



34
35
36
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 34

def type
  @type
end

#weekObject

Returns the value of attribute week.



36
37
38
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 36

def week
  @week
end

Class Method Details

._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



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
327
328
329
330
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 293

def self._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 = FeratelCheckApiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



77
78
79
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 61

def self.attribute_map
  {
    :'auto_exit' => :'autoExit',
    :'auto_exit_interval' => :'autoExitInterval',
    :'count_n' => :'countN',
    :'count_m' => :'countM',
    :'double_use_timeout' => :'doubleUseTimeout',
    :'from_date' => :'fromDate',
    :'not_usable_on_first_or_last_day' => :'notUsableOnFirstOrLastDay',
    :'to_date' => :'toDate',
    :'type' => :'type',
    :'week' => :'week'
  }
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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 269

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

.openapi_nullableObject

List of attributes with nullable: true



98
99
100
101
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 98

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

.openapi_typesObject

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 82

def self.openapi_types
  {
    :'auto_exit' => :'String',
    :'auto_exit_interval' => :'Integer',
    :'count_n' => :'Integer',
    :'count_m' => :'Integer',
    :'double_use_timeout' => :'Integer',
    :'from_date' => :'String',
    :'not_usable_on_first_or_last_day' => :'Boolean',
    :'to_date' => :'String',
    :'type' => :'ServiceUsageType',
    :'week' => :'Week'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 239

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_exit == o.auto_exit &&
      auto_exit_interval == o.auto_exit_interval &&
      count_n == o.count_n &&
      count_m == o.count_m &&
      double_use_timeout == o.double_use_timeout &&
      from_date == o.from_date &&
      not_usable_on_first_or_last_day == o.not_usable_on_first_or_last_day &&
      to_date == o.to_date &&
      type == o.type &&
      week == o.week
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



364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 364

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


256
257
258
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 256

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



262
263
264
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 262

def hash
  [auto_exit, auto_exit_interval, count_n, count_m, double_use_timeout, from_date, not_usable_on_first_or_last_day, to_date, type, week].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 161

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?$/)
  if !@auto_exit.nil? && @auto_exit !~ pattern
    invalid_properties.push("invalid value for \"auto_exit\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?$/)
  if !@from_date.nil? && @from_date !~ pattern
    invalid_properties.push("invalid value for \"from_date\", must conform to the pattern #{pattern}.")
  end

  pattern = Regexp.new(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?$/)
  if !@to_date.nil? && @to_date !~ pattern
    invalid_properties.push("invalid value for \"to_date\", must conform to the pattern #{pattern}.")
  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



340
341
342
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 340

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



346
347
348
349
350
351
352
353
354
355
356
357
358
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 346

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



334
335
336
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 334

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



184
185
186
187
188
189
190
# File 'lib/feratel-check-api-client/models/service_usage.rb', line 184

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@auto_exit.nil? && @auto_exit !~ Regexp.new(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?$/)
  return false if !@from_date.nil? && @from_date !~ Regexp.new(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?$/)
  return false if !@to_date.nil? && @to_date !~ Regexp.new(/^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?$/)
  true
end