Class: LinodeOpenapiClient::PostLinodeConfigInterfaceRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostLinodeConfigInterfaceRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 119

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

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

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

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

  if attributes.key?(:'ip_ranges')
    if (value = attributes[:'ip_ranges']).is_a?(Array)
      self.ip_ranges = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Returns ‘true` if the Interface is in use, meaning that Compute Instance has been booted using the Configuration Profile to which the Interface belongs. Otherwise returns `false`.



45
46
47
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 45

def active
  @active
end

#id ⇒ Object

Read-only The unique ID representing this Interface.



40
41
42
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 40

def id
  @id
end

#ip_ranges ⇒ Object

An array of IPv4 CIDR VPC Subnet ranges that are routed to this Interface. - Array items are only allowed for ‘vpc` type Interfaces. - This must be empty for non-`vpc` type Interfaces. For requests: - Addresses in submitted ranges must not already be actively assigned. - Submitting values replaces any existing values. - Submitting an empty array removes any existing values. - Omitting this property results in no change to existing values.



31
32
33
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 31

def ip_ranges
  @ip_ranges
end

#ipam_address ⇒ Object

This Network Interface’s private IP address in Classless Inter-Domain Routing (CIDR) notation. For ‘vlan` purpose Interfaces: - Must be unique among the Linode’s Interfaces to avoid conflicting addresses. - Should be unique among devices attached to the VLAN to avoid conflict. - The Linode is configured to use this address for the associated Interface upon reboot if Network Helper is enabled. If Network Helper is disabled, the address can be enabled with [manual static IP configuration](www.linode.com/docs/guides/manual-network-configuration/). For ‘public` purpose Interfaces: - In requests, must be an empty string (`""`) or `null` if included. - In responses, always returns `null`. For `vpc` purpose Interfaces: - In requests, must be an empty string (`""`) or `null` if included. - In responses, always returns `null`.



28
29
30
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 28

def ipam_address
  @ipam_address
end

#ipv4 ⇒ Object

Returns the value of attribute ipv4.



42
43
44
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 42

def ipv4
  @ipv4
end

#label ⇒ Object

__Filterable__ The name of this Interface. For ‘vlan` purpose Interfaces: - Required. - Must be unique among the Linode’s Interfaces (a Linode cannot be attached to the same VLAN multiple times). - Can only contain ASCII letters, numbers, and hyphens (‘-`). You can’t use two consecutive hyphens (‘–`). - If the VLAN label is new, a VLAN is created. Up to 10 VLANs can be created in each data center region. To view your active VLANs, run the [List VLANs](techdocs.akamai.com/linode-api/reference/get-vlans) operation. For `public` purpose Interfaces: - In requests, must be an empty string (`""`) or `null` if included. - In responses, always returns `null`. For `vpc` purpose Interfaces: - In requests, must be an empty string (`""`) or `null` if included. - In responses, always returns `null`.



22
23
24
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 22

def label
  @label
end

#primary ⇒ Object

The primary Interface is configured as the default route to the Linode. Each Configuration Profile can have up to one ‘"primary": true` Interface at a time. Must be `false` for `vlan` type Interfaces. If no Interface is configured as the primary, the first non-`vlan` type Interface in the `interfaces` array is automatically treated as the primary Interface.



25
26
27
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 25

def primary
  @primary
end

#purpose ⇒ Object

The type of Interface. - ‘public` - Only one `public` Interface per Linode can be defined. - The Linode’s default public IPv4 address is assigned to the ‘public` Interface. - A Linode must have a public Interface in the first/eth0 position to be reachable via the public internet upon boot without additional system configuration. If no `public` Interface is configured, the Linode is not directly reachable via the public internet. In this case, access can only be established via [LISH](www.linode.com/docs/products/compute/compute-instances/guides/lish/) or other Linodes connected to the same VLAN or VPC. - `vlan` - Configuring a `vlan` purpose Interface attaches this Linode to the VLAN with the specified `label`. - The Linode is configured to use the specified `ipam_address`, if any. - `vpc` - Configuring a `vpc` purpose Interface attaches this Linode to the existing VPC Subnet with the specified `subnet_id`. - When the Interface is activated, the Linode is configured to use an IP address from the range in the assigned VPC Subnet. See `ipv4.vpc` for more information.



34
35
36
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 34

def purpose
  @purpose
end

#subnet_id ⇒ Object

The ‘id` of the VPC Subnet for this Interface. In requests, this value is used to assign a Linode to a VPC Subnet. - Required for `vpc` type Interfaces. - Returns `null` for non-`vpc` type Interfaces. - Once a VPC Subnet is assigned to an Interface, it cannot be updated. - The Linode must be rebooted with the Interface’s Configuration Profile to complete assignment to a VPC Subnet.



19
20
21
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 19

def subnet_id
  @subnet_id
end

#vpc_id ⇒ Object

Read-only The ‘id` of the VPC configured for this Interface. Returns `null` for non-`vpc` type Interfaces.



37
38
39
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 37

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



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
331
332
333
334
335
336
337
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 300

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



86
87
88
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 86

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 70

def self.attribute_map
  {
    :'subnet_id' => :'subnet_id',
    :'label' => :'label',
    :'primary' => :'primary',
    :'ipam_address' => :'ipam_address',
    :'ip_ranges' => :'ip_ranges',
    :'purpose' => :'purpose',
    :'vpc_id' => :'vpc_id',
    :'id' => :'id',
    :'ipv4' => :'ipv4',
    :'active' => :'active'
  }
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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 276

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



107
108
109
110
111
112
113
114
115
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 107

def self.openapi_nullable
  Set.new([
    :'subnet_id',
    :'label',
    :'ipam_address',
    :'ip_ranges',
    :'vpc_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 91

def self.openapi_types
  {
    :'subnet_id' => :'Integer',
    :'label' => :'String',
    :'primary' => :'Boolean',
    :'ipam_address' => :'String',
    :'ip_ranges' => :'Array<String>',
    :'purpose' => :'String',
    :'vpc_id' => :'Integer',
    :'id' => :'Integer',
    :'ipv4' => :'PostLinodeInstanceRequestAllOfInterfacesInnerIpv4',
    :'active' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      subnet_id == o.subnet_id &&
      label == o.label &&
      primary == o.primary &&
      ipam_address == o.ipam_address &&
      ip_ranges == o.ip_ranges &&
      purpose == o.purpose &&
      vpc_id == o.vpc_id &&
      id == o.id &&
      ipv4 == o.ipv4 &&
      active == o.active
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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 371

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


263
264
265
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



269
270
271
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 269

def hash
  [subnet_id, label, primary, ipam_address, ip_ranges, purpose, vpc_id, id, ipv4, active].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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 179

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@label.nil? && @label.to_s.length > 64
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 64.')
  end

  if !@label.nil? && @label.to_s.length < 1
    invalid_properties.push('invalid value for "label", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/[a-zA-Z0-9-]+/)
  if !@label.nil? && @label !~ pattern
    invalid_properties.push("invalid value for \"label\", must conform to the pattern #{pattern}.")
  end

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



347
348
349
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 347

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



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

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



341
342
343
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 341

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



204
205
206
207
208
209
210
211
212
213
 
# File 'lib/linode_openapi_client/models/post_linode_config_interface_request.rb', line 204

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@label.nil? && @label.to_s.length > 64
  return false if !@label.nil? && @label.to_s.length < 1
  return false if !@label.nil? && @label !~ Regexp.new(/[a-zA-Z0-9-]+/)
  return false if @purpose.nil?
  purpose_validator = EnumAttributeValidator.new('String', ["public", "vlan", "vpc"])
  return false unless purpose_validator.valid?(@purpose)
  true
end