Class: LinodeOpenapiClient::PutFirewall200ResponseRulesInboundInner

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

Overview

One of a Firewall’s inbound or outbound access rules. The ‘ports` property can be used to allow traffic on a comma-separated list of different ports.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PutFirewall200ResponseRulesInboundInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
126
127
128
129
130
131
132
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 96

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ Object

Controls whether traffic is accepted or dropped by this rule. Overrides the Firewall’s ‘inbound_policy` if this is an inbound rule, or the `outbound_policy` if this is an outbound rule.



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

def action
  @action
end

#addresses ⇒ Object

Returns the value of attribute addresses.



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

def addresses
  @addresses
end

#description ⇒ Object

Used to describe this rule. For display purposes only.



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

def description
  @description
end

#label ⇒ Object

Used to identify this rule. For display purposes only.



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

def label
  @label
end

#ports ⇒ Object

A string representing the port or ports affected by this rule: - The string may be a single port, a range of ports, or a comma-separated list of single ports and port ranges. A space is permitted following each comma. - A range of ports is inclusive of the start and end values for the range. The end value of the range must be greater than the start value. - Ports must be within 1 and 65535, and may not contain any leading zeroes. For example, port ‘080` is not allowed. - The ports string can have up to 15 pieces, where a single port is treated as one piece, and a port range is treated as two pieces. For example, the string "22-24, 80, 443" has four pieces. - If no ports are configured, all ports are affected. - Only allowed for the TCP and UDP protocols. Ports are not allowed for the ICMP and IPENCAP protocols.



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

def ports
  @ports
end

#protocol ⇒ Object

The type of network traffic affected by this rule.



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

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



281
282
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
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 281

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



71
72
73
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 71

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 59

def self.attribute_map
  {
    :'addresses' => :'addresses',
    :'ports' => :'ports',
    :'protocol' => :'protocol',
    :'label' => :'label',
    :'description' => :'description',
    :'action' => :'action'
  }
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



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

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 76

def self.openapi_types
  {
    :'addresses' => :'GetFirewall200ResponseRulesInboundInnerAddresses',
    :'ports' => :'String',
    :'protocol' => :'String',
    :'label' => :'String',
    :'description' => :'String',
    :'action' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      addresses == o.addresses &&
      ports == o.ports &&
      protocol == o.protocol &&
      label == o.label &&
      description == o.description &&
      action == o.action
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



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

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


244
245
246
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 250

def hash
  [addresses, ports, protocol, label, description, action].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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 136

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

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

  if !@description.nil? && @description.to_s.length > 100
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 100.')
  end

  if !@description.nil? && @description.to_s.length < 1
    invalid_properties.push('invalid value for "description", the character length must be great than or equal to 1.')
  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



328
329
330
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 328

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 334

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



322
323
324
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 322

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



160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/linode_openapi_client/models/put_firewall200_response_rules_inbound_inner.rb', line 160

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  protocol_validator = EnumAttributeValidator.new('String', ["TCP", "UDP", "ICMP", "IPENCAP"])
  return false unless protocol_validator.valid?(@protocol)
  return false if !@label.nil? && @label.to_s.length > 32
  return false if !@label.nil? && @label.to_s.length < 3
  return false if !@description.nil? && @description.to_s.length > 100
  return false if !@description.nil? && @description.to_s.length < 1
  action_validator = EnumAttributeValidator.new('String', ["ACCEPT", "DROP"])
  return false unless action_validator.valid?(@action)
  true
end