Class: KatapultAPI::PostOrganizationIpAddressesRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostOrganizationIpAddressesRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 87

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

  if attributes.key?(:'network')
    self.network = attributes[:'network']
  else
    self.network = nil
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  else
    self.version = nil
  end

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

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

Instance Attribute Details

#label ⇒ Object

The label to give this address if setting it as a VIP



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

def label
  @label
end

#network ⇒ Object

Returns the value of attribute network.



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

def network
  @network
end

#organization ⇒ Object

Returns the value of attribute organization.



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

def organization
  @organization
end

#version ⇒ Object

Returns the value of attribute version.



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

def version
  @version
end

#vip ⇒ Object

Whether or not to set this address as a VIP



25
26
27
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 25

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 208

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



64
65
66
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 53

def self.attribute_map
  {
    :'organization' => :'organization',
    :'network' => :'network',
    :'version' => :'version',
    :'vip' => :'vip',
    :'label' => :'label'
  }
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 184

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



80
81
82
83
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 69

def self.openapi_types
  {
    :'organization' => :'OrganizationLookup',
    :'network' => :'NetworkLookup',
    :'version' => :'IPAddressVersionEnum',
    :'vip' => :'Boolean',
    :'label' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      organization == o.organization &&
      network == o.network &&
      version == o.version &&
      vip == o.vip &&
      label == o.label
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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 279

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


171
172
173
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



177
178
179
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 177

def hash
  [organization, network, version, vip, label].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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 129

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @organization.nil?
    invalid_properties.push('invalid value for "organization", organization cannot be nil.')
  end

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

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



255
256
257
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 255

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 261

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



249
250
251
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 249

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



149
150
151
152
153
154
155
 
# File 'lib/katapult-ruby/models/post_organization_ip_addresses_request.rb', line 149

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @organization.nil?
  return false if @network.nil?
  return false if @version.nil?
  true
end