Class: KatapultAPI::OrganizationPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/katapult-ruby/models/organization_policy.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrganizationPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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/katapult-ruby/models/organization_policy.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#allow_restricted_traffic_types ⇒ Object

Returns the value of attribute allow_restricted_traffic_types.



48
49
50
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 48

def allow_restricted_traffic_types
  @allow_restricted_traffic_types
end

#allow_suspension ⇒ Object

Returns the value of attribute allow_suspension.



46
47
48
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 46

def allow_suspension
  @allow_suspension
end

#flexible_virtual_machine_resources ⇒ Object

Returns the value of attribute flexible_virtual_machine_resources.



44
45
46
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 44

def flexible_virtual_machine_resources
  @flexible_virtual_machine_resources
end

#maximum_certificates ⇒ Object

Returns the value of attribute maximum_certificates.



38
39
40
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 38

def maximum_certificates
  @maximum_certificates
end

#maximum_disk_space ⇒ Object

Returns the value of attribute maximum_disk_space.



24
25
26
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 24

def maximum_disk_space
  @maximum_disk_space
end

#maximum_dns_zones ⇒ Object

Returns the value of attribute maximum_dns_zones.



36
37
38
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 36

def maximum_dns_zones
  @maximum_dns_zones
end

#maximum_file_storage_volumes ⇒ Object

Returns the value of attribute maximum_file_storage_volumes.



40
41
42
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 40

def maximum_file_storage_volumes
  @maximum_file_storage_volumes
end

#maximum_isos ⇒ Object

Returns the value of attribute maximum_isos.



42
43
44
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 42

def maximum_isos
  @maximum_isos
end

#maximum_load_balancers ⇒ Object

Returns the value of attribute maximum_load_balancers.



34
35
36
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 34

def maximum_load_balancers
  @maximum_load_balancers
end

#maximum_managed_organizations ⇒ Object

Returns the value of attribute maximum_managed_organizations.



26
27
28
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 26

def maximum_managed_organizations
  @maximum_managed_organizations
end

#maximum_security_groups ⇒ Object

Returns the value of attribute maximum_security_groups.



30
31
32
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 30

def maximum_security_groups
  @maximum_security_groups
end

#maximum_unallocated_ip_addresses ⇒ Object

Returns the value of attribute maximum_unallocated_ip_addresses.



28
29
30
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 28

def maximum_unallocated_ip_addresses
  @maximum_unallocated_ip_addresses
end

#maximum_uninvoiced_balance ⇒ Object

Returns the value of attribute maximum_uninvoiced_balance.



18
19
20
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 18

def maximum_uninvoiced_balance
  @maximum_uninvoiced_balance
end

#maximum_virtual_machine_memory ⇒ Object

Returns the value of attribute maximum_virtual_machine_memory.



22
23
24
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 22

def maximum_virtual_machine_memory
  @maximum_virtual_machine_memory
end

#maximum_virtual_machines ⇒ Object

Returns the value of attribute maximum_virtual_machines.



20
21
22
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 20

def maximum_virtual_machines
  @maximum_virtual_machines
end

#maximum_virtual_networks ⇒ Object

Returns the value of attribute maximum_virtual_networks.



32
33
34
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 32

def maximum_virtual_networks
  @maximum_virtual_networks
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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 262

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 = KatapultAPI.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_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 51

def self.attribute_map
  {
    :'maximum_uninvoiced_balance' => :'maximum_uninvoiced_balance',
    :'maximum_virtual_machines' => :'maximum_virtual_machines',
    :'maximum_virtual_machine_memory' => :'maximum_virtual_machine_memory',
    :'maximum_disk_space' => :'maximum_disk_space',
    :'maximum_managed_organizations' => :'maximum_managed_organizations',
    :'maximum_unallocated_ip_addresses' => :'maximum_unallocated_ip_addresses',
    :'maximum_security_groups' => :'maximum_security_groups',
    :'maximum_virtual_networks' => :'maximum_virtual_networks',
    :'maximum_load_balancers' => :'maximum_load_balancers',
    :'maximum_dns_zones' => :'maximum_dns_zones',
    :'maximum_certificates' => :'maximum_certificates',
    :'maximum_file_storage_volumes' => :'maximum_file_storage_volumes',
    :'maximum_isos' => :'maximum_isos',
    :'flexible_virtual_machine_resources' => :'flexible_virtual_machine_resources',
    :'allow_suspension' => :'allow_suspension',
    :'allow_restricted_traffic_types' => :'allow_restricted_traffic_types'
  }
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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 238

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_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 78

def self.openapi_types
  {
    :'maximum_uninvoiced_balance' => :'DecimalOrUnlimited',
    :'maximum_virtual_machines' => :'IntegerOrUnlimited',
    :'maximum_virtual_machine_memory' => :'IntegerOrUnlimited',
    :'maximum_disk_space' => :'IntegerOrUnlimited',
    :'maximum_managed_organizations' => :'IntegerOrUnlimited',
    :'maximum_unallocated_ip_addresses' => :'IntegerOrUnlimited',
    :'maximum_security_groups' => :'IntegerOrUnlimited',
    :'maximum_virtual_networks' => :'IntegerOrUnlimited',
    :'maximum_load_balancers' => :'IntegerOrUnlimited',
    :'maximum_dns_zones' => :'IntegerOrUnlimited',
    :'maximum_certificates' => :'IntegerOrUnlimited',
    :'maximum_file_storage_volumes' => :'IntegerOrUnlimited',
    :'maximum_isos' => :'IntegerOrUnlimited',
    :'flexible_virtual_machine_resources' => :'Boolean',
    :'allow_suspension' => :'Boolean',
    :'allow_restricted_traffic_types' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      maximum_uninvoiced_balance == o.maximum_uninvoiced_balance &&
      maximum_virtual_machines == o.maximum_virtual_machines &&
      maximum_virtual_machine_memory == o.maximum_virtual_machine_memory &&
      maximum_disk_space == o.maximum_disk_space &&
      maximum_managed_organizations == o.maximum_managed_organizations &&
      maximum_unallocated_ip_addresses == o.maximum_unallocated_ip_addresses &&
      maximum_security_groups == o.maximum_security_groups &&
      maximum_virtual_networks == o.maximum_virtual_networks &&
      maximum_load_balancers == o.maximum_load_balancers &&
      maximum_dns_zones == o.maximum_dns_zones &&
      maximum_certificates == o.maximum_certificates &&
      maximum_file_storage_volumes == o.maximum_file_storage_volumes &&
      maximum_isos == o.maximum_isos &&
      flexible_virtual_machine_resources == o.flexible_virtual_machine_resources &&
      allow_suspension == o.allow_suspension &&
      allow_restricted_traffic_types == o.allow_restricted_traffic_types
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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 333

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


225
226
227
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 231

def hash
  [maximum_uninvoiced_balance, maximum_virtual_machines, maximum_virtual_machine_memory, maximum_disk_space, maximum_managed_organizations, maximum_unallocated_ip_addresses, maximum_security_groups, maximum_virtual_networks, maximum_load_balancers, maximum_dns_zones, maximum_certificates, maximum_file_storage_volumes, maximum_isos, flexible_virtual_machine_resources, allow_suspension, allow_restricted_traffic_types].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
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 187

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



309
310
311
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 309

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 315

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



303
304
305
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 303

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



195
196
197
198
 
# File 'lib/katapult-ruby/models/organization_policy.rb', line 195

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end