Class: OCI::Core::Models::IcmpOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/icmp_options.rb

Overview

Optional object to specify a particular ICMP type and code. If you specify ICMP as the protocol but do not provide this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. See [ICMP Parameters](www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) for allowed values. To enable MTU negotiation for ingress internet traffic, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don’t Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IcmpOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :code (Integer) —

    The value to assign to the #code property

  • :type (Integer) —

    The value to assign to the #type property



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/core/models/icmp_options.rb', line 52

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.code = attributes[:'code'] if attributes[:'code']

  self.type = attributes[:'type'] if attributes[:'type']
end

Instance Attribute Details

#code ⇒ Integer

The ICMP code (optional).

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/core/models/icmp_options.rb', line 18

def code
  @code
end

#type ⇒ Integer

[Required] The ICMP type.

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/core/models/icmp_options.rb', line 22

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
 
# File 'lib/oci/core/models/icmp_options.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'code',
    'type': :'type'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
 
# File 'lib/oci/core/models/icmp_options.rb', line 35

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'Integer',
    'type': :'Integer'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



70
71
72
73
74
75
76
 
# File 'lib/oci/core/models/icmp_options.rb', line 70

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    code == other.code &&
    type == other.type
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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/core/models/icmp_options.rb', line 101

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


81
82
83
 
# File 'lib/oci/core/models/icmp_options.rb', line 81

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



90
91
92
 
# File 'lib/oci/core/models/icmp_options.rb', line 90

def hash
  [code, type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/core/models/icmp_options.rb', line 134

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



128
129
130
 
# File 'lib/oci/core/models/icmp_options.rb', line 128

def to_s
  to_hash.to_s
end