Class: LinodeOpenapiClient::PutLinodeConfigInterfaceRequestIpv4

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

Overview

IPv4 addresses configured for this Interface. Only allowed for ‘vpc` type Interfaces. Returns `null` if no `vpc` Interface is assigned.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PutLinodeConfigInterfaceRequestIpv4

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 56

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

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

Instance Attribute Details

#nat_1_1 ⇒ Object

The 1:1 NAT IPv4 address, used to associate a public IPv4 address with the VPC Subnet IPv4 address assigned to this Interface. - Only allowed for ‘vpc` type Interfaces. - Returns `null` if no 1:1 NAT is set for a `vpc` type Interface. - Returns an empty string (`""`) for non-`vpc` type Interfaces. For requests: - Setting this value to `any` enables the Linode’s assigned public IPv4 address on this Interface and establishes a 1:1 NAT between the public IPv4 and VPC Subnet IPv4 addresses. - Setting the value to a specific public IPv4 address that is assigned to the Linode enables a 1:1 NAT between that address and the VPC Subnet IPv4 address. - The public IPv4 address can’t be shared with another Linode. - If omitted, set to ‘null`, or set to an empty string (`""`), no 1:1 NAT is established. __Note__. When creating a new compute-instance, you can’t set this to a specific IPv4 address. When a new compute instance is created, the network establishes a public IPv4 address for it. Since this address doesn’t exist yet, you can’t include a custom IPv4 address to change it. Once your compute instances is created, you can [update your configuration profile interface](www.linode.com/docs/api/linode-instances/#configuration-profile-interface-update) to change the ‘nat_1_1` address.



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

def nat_1_1
  @nat_1_1
end

#vpc ⇒ Object

The VPC Subnet IPv4 address for this Interface. - Only allowed for ‘vpc` type Interfaces. - Returns an empty string (`""`) for non-`vpc` type Interfaces. For requests: - Must not already be actively assigned as an address or within a range to any Linodes. - Must not be the first two or last two addresses in the Subnet IPv4 Range. - If omitted, a valid address within the Subnet IPv4 range is automatically assigned.



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

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



26
27
28
29
30
31
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 26

def self.attribute_map
  {
    :'nat_1_1' => :'nat_1_1',
    :'vpc' => :'vpc'
  }
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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 117

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



47
48
49
50
51
52
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 47

def self.openapi_nullable
  Set.new([
    :'nat_1_1',
    :'vpc'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 39

def self.openapi_types
  {
    :'nat_1_1' => :'String',
    :'vpc' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



95
96
97
98
99
100
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 95

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      nat_1_1 == o.nat_1_1 &&
      vpc == o.vpc
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



212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 212

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


104
105
106
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 104

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



110
111
112
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 110

def hash
  [nat_1_1, vpc].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



80
81
82
83
84
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 80

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



188
189
190
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 188

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



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 194

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



182
183
184
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 182

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



88
89
90
91
 
# File 'lib/linode_openapi_client/models/put_linode_config_interface_request_ipv4.rb', line 88

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