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

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

Overview

Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - ICMP Parameters - ICMPv6 Parameters

If you specify ICMP or ICMPv6 as the protocol but omit 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. To enable MTU negotiation for ingress internet traffic via IPv4, 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



57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/core/models/icmp_options.rb', line 57

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) 


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

def code
  @code
end

#type ⇒ Integer

[Required] The ICMP type.

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/oci/core/models/icmp_options.rb', line 27

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/oci/core/models/icmp_options.rb', line 30

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

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/oci/core/models/icmp_options.rb', line 40

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



75
76
77
78
79
80
81
 
# File 'lib/oci/core/models/icmp_options.rb', line 75

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/core/models/icmp_options.rb', line 106

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


86
87
88
 
# File 'lib/oci/core/models/icmp_options.rb', line 86

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



95
96
97
 
# File 'lib/oci/core/models/icmp_options.rb', line 95

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



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/core/models/icmp_options.rb', line 139

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



133
134
135
 
# File 'lib/oci/core/models/icmp_options.rb', line 133

def to_s
  to_hash.to_s
end