Class: OCI::Core::Models::EgressSecurityRule

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

Overview

A rule for allowing outbound IP packets.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EgressSecurityRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 96

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.destination = attributes[:'destination'] if attributes[:'destination']

  self.icmp_options = attributes[:'icmpOptions'] if attributes[:'icmpOptions']

  raise 'You cannot provide both :icmpOptions and :icmp_options' if attributes.key?(:'icmpOptions') && attributes.key?(:'icmp_options')

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

  self.is_stateless = attributes[:'isStateless'] unless attributes[:'isStateless'].nil?

  raise 'You cannot provide both :isStateless and :is_stateless' if attributes.key?(:'isStateless') && attributes.key?(:'is_stateless')

  self.is_stateless = attributes[:'is_stateless'] unless attributes[:'is_stateless'].nil?

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

  self.tcp_options = attributes[:'tcpOptions'] if attributes[:'tcpOptions']

  raise 'You cannot provide both :tcpOptions and :tcp_options' if attributes.key?(:'tcpOptions') && attributes.key?(:'tcp_options')

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

  self.udp_options = attributes[:'udpOptions'] if attributes[:'udpOptions']

  raise 'You cannot provide both :udpOptions and :udp_options' if attributes.key?(:'udpOptions') && attributes.key?(:'udp_options')

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

Instance Attribute Details

#destination ⇒ String

[Required] The destination CIDR block for the egress rule. This is the range of IP addresses that a packet originating from the instance can go to.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 13

def destination
  @destination
end

#icmp_options ⇒ OCI::Core::Models::IcmpOptions

Optional and valid only for ICMP. Use to specify a particular ICMP type and code as defined in [ICMP Parameters](www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml). If you specify ICMP 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, 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.

Returns:



25
26
27
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 25

def icmp_options
  @icmp_options
end

#is_stateless ⇒ BOOLEAN

A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.

Returns:

  • (BOOLEAN) 


34
35
36
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 34

def is_stateless
  @is_stateless
end

#protocol ⇒ String

[Required] The transport protocol. Specify either all or an IPv4 protocol number as defined in [Protocol Numbers](www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP ("1"), TCP ("6"), and UDP ("17").

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 42

def protocol
  @protocol
end

#tcp_options ⇒ OCI::Core::Models::TcpOptions

Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.

Returns:



48
49
50
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 48

def tcp_options
  @tcp_options
end

#udp_options ⇒ OCI::Core::Models::UdpOptions

Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.

Returns:



54
55
56
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 54

def udp_options
  @udp_options
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'destination': :'destination',
    'icmp_options': :'icmpOptions',
    'is_stateless': :'isStateless',
    'protocol': :'protocol',
    'tcp_options': :'tcpOptions',
    'udp_options': :'udpOptions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 71

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'destination': :'String',
    'icmp_options': :'OCI::Core::Models::IcmpOptions',
    'is_stateless': :'BOOLEAN',
    'protocol': :'String',
    'tcp_options': :'OCI::Core::Models::TcpOptions',
    'udp_options': :'OCI::Core::Models::UdpOptions'
    # 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



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

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    destination == other.destination &&
    icmp_options == other.icmp_options &&
    is_stateless == other.is_stateless &&
    protocol == other.protocol &&
    tcp_options == other.tcp_options &&
    udp_options == other.udp_options
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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 172

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


152
153
154
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 152

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 161

def hash
  [destination, icmp_options, is_stateless, protocol, tcp_options, udp_options].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 204

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



198
199
200
 
# File 'lib/oci/core/models/egress_security_rule.rb', line 198

def to_s
  to_hash.to_s
end