Class: LinodeOpenapiClient::GetVpcIps200Response

Inherits:
Object
  • Object
show all
Defined in:
lib/linode_openapi_client/models/get_vpc_ips200_response.rb

Overview

The response data for the VPC IP Addresses List and View operations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetVpcIps200Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 128

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

__Filterable__, Read-only Returns ‘true` if the VPC interface is in use, meaning that the Linode was powered on using the `config_id` to which the interface belongs. Otherwise returns `false`.



53
54
55
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 53

def active
  @active
end

#address ⇒ Object

Read-only An IPv4 address configured for this VPC interface. These follow the [RFC 1918](datatracker.ietf.org/doc/html/rfc1918) private address format. Displayed as ‘null` if an `address_range`.



62
63
64
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 62

def address
  @address
end

#address_range ⇒ Object

Read-only A range of IPv4 addresses configured for this VPC interface. Displayed as ‘null` if a single `address`.



56
57
58
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 56

def address_range
  @address_range
end

#config_id ⇒ Object

__Filterable__, Read-only The globally general entity identifier for the Linode configuration profile where the VPC is included.



65
66
67
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 65

def config_id
  @config_id
end

#gateway ⇒ Object

Read-only The default gateway for the VPC subnet that the IP or IP range belongs to.



44
45
46
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 44

def gateway
  @gateway
end

#interface_id ⇒ Object

Read-only The globally general API entity identifier for the Linode interface.



41
42
43
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 41

def interface_id
  @interface_id
end

#linode_id ⇒ Object

__Filterable__, Read-only The identifier for the Linode the VPC interface currently belongs to.



47
48
49
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 47

def linode_id
  @linode_id
end

#nat_1_1 ⇒ Object

Read-only The public IP address used for NAT 1:1 with the VPC. This is empty if NAT 1:1 isn’t used.



38
39
40
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 38

def nat_1_1
  @nat_1_1
end

#page ⇒ Object

Read-only The current [page](techdocs.akamai.com/linode-api/reference/pagination).



26
27
28
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 26

def page
  @page
end

#pages ⇒ Object

Read-only The total number of [pages](techdocs.akamai.com/linode-api/reference/pagination).



23
24
25
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 23

def pages
  @pages
end

#prefix ⇒ Object

Read-only The number of bits set in the ‘subnet_mask`.



32
33
34
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 32

def prefix
  @prefix
end

#region ⇒ Object

__Filterable__, Read-only The region of the VPC.



59
60
61
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 59

def region
  @region
end

#results ⇒ Object

Read-only The total number of results.



20
21
22
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 20

def results
  @results
end

#subnet_id ⇒ Object

The ‘id` of the VPC Subnet for this interface.



29
30
31
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 29

def subnet_id
  @subnet_id
end

#subnet_mask ⇒ Object

Read-only The mask that separates host bits from network bits for the ‘address` or `address_range`.



35
36
37
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 35

def subnet_mask
  @subnet_mask
end

#vpc_id ⇒ Object

__Filterable__, Read-only The unique globally general API entity identifier for the VPC.



50
51
52
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 50

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



283
284
285
286
287
288
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
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 283

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



90
91
92
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 68

def self.attribute_map
  {
    :'results' => :'results',
    :'pages' => :'pages',
    :'page' => :'page',
    :'subnet_id' => :'subnet_id',
    :'prefix' => :'prefix',
    :'subnet_mask' => :'subnet_mask',
    :'nat_1_1' => :'nat_1_1',
    :'interface_id' => :'interface_id',
    :'gateway' => :'gateway',
    :'linode_id' => :'linode_id',
    :'vpc_id' => :'vpc_id',
    :'active' => :'active',
    :'address_range' => :'address_range',
    :'region' => :'region',
    :'address' => :'address',
    :'config_id' => :'config_id'
  }
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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 259

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



117
118
119
120
121
122
123
124
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 117

def self.openapi_nullable
  Set.new([
    :'prefix',
    :'gateway',
    :'address_range',
    :'address',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 95

def self.openapi_types
  {
    :'results' => :'Integer',
    :'pages' => :'Integer',
    :'page' => :'Integer',
    :'subnet_id' => :'Integer',
    :'prefix' => :'Integer',
    :'subnet_mask' => :'String',
    :'nat_1_1' => :'String',
    :'interface_id' => :'Integer',
    :'gateway' => :'String',
    :'linode_id' => :'Integer',
    :'vpc_id' => :'Integer',
    :'active' => :'Boolean',
    :'address_range' => :'String',
    :'region' => :'String',
    :'address' => :'String',
    :'config_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 223

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      results == o.results &&
      pages == o.pages &&
      page == o.page &&
      subnet_id == o.subnet_id &&
      prefix == o.prefix &&
      subnet_mask == o.subnet_mask &&
      nat_1_1 == o.nat_1_1 &&
      interface_id == o.interface_id &&
      gateway == o.gateway &&
      linode_id == o.linode_id &&
      vpc_id == o.vpc_id &&
      active == o.active &&
      address_range == o.address_range &&
      region == o.region &&
      address == o.address &&
      config_id == o.config_id
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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 354

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


246
247
248
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



252
253
254
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 252

def hash
  [results, pages, page, subnet_id, prefix, subnet_mask, nat_1_1, interface_id, gateway, linode_id, vpc_id, active, address_range, region, address, config_id].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



208
209
210
211
212
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 208

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



330
331
332
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 336

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



324
325
326
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 324

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



216
217
218
219
 
# File 'lib/linode_openapi_client/models/get_vpc_ips200_response.rb', line 216

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