Class: OCI::Core::Models::IngressSecurityRule
- Inherits:
-
Object
- Object
- OCI::Core::Models::IngressSecurityRule
- Defined in:
- lib/oci/core/models/ingress_security_rule.rb
Overview
A rule for allowing inbound IP packets.
Constant Summary collapse
- SOURCE_TYPE_ENUM =
[ SOURCE_TYPE_CIDR_BLOCK = 'CIDR_BLOCK'.freeze, SOURCE_TYPE_SERVICE_CIDR_BLOCK = 'SERVICE_CIDR_BLOCK'.freeze, SOURCE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#description ⇒ String
An optional description of your choice for the rule.
-
#icmp_options ⇒ OCI::Core::Models::IcmpOptions
Optional and valid only for ICMP and ICMPv6.
-
#is_stateless ⇒ BOOLEAN
A stateless rule allows traffic in one direction.
-
#protocol ⇒ String
[Required] The transport protocol.
-
#source ⇒ String
[Required] Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
-
#source_type ⇒ String
Type of source for the rule.
-
#tcp_options ⇒ OCI::Core::Models::TcpOptions
Optional and valid only for TCP.
-
#udp_options ⇒ OCI::Core::Models::UdpOptions
Optional and valid only for UDP.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ IngressSecurityRule
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ IngressSecurityRule
Initializes the object
139 140 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 179 180 181 182 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 139 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. = attributes[:'icmpOptions'] if attributes[:'icmpOptions'] raise 'You cannot provide both :icmpOptions and :icmp_options' if attributes.key?(:'icmpOptions') && attributes.key?(:'icmp_options') self. = 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.source = attributes[:'source'] if attributes[:'source'] self.source_type = attributes[:'sourceType'] if attributes[:'sourceType'] self.source_type = "CIDR_BLOCK" if source_type.nil? && !attributes.key?(:'sourceType') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :sourceType and :source_type' if attributes.key?(:'sourceType') && attributes.key?(:'source_type') self.source_type = attributes[:'source_type'] if attributes[:'source_type'] self.source_type = "CIDR_BLOCK" if source_type.nil? && !attributes.key?(:'sourceType') && !attributes.key?(:'source_type') # rubocop:disable Style/StringLiterals self. = attributes[:'tcpOptions'] if attributes[:'tcpOptions'] raise 'You cannot provide both :tcpOptions and :tcp_options' if attributes.key?(:'tcpOptions') && attributes.key?(:'tcp_options') self. = attributes[:'tcp_options'] if attributes[:'tcp_options'] self. = attributes[:'udpOptions'] if attributes[:'udpOptions'] raise 'You cannot provide both :udpOptions and :udp_options' if attributes.key?(:'udpOptions') && attributes.key?(:'udp_options') self. = attributes[:'udp_options'] if attributes[:'udp_options'] self.description = attributes[:'description'] if attributes[:'description'] end |
Instance Attribute Details
#description ⇒ String
An optional description of your choice for the rule.
91 92 93 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 91 def description @description end |
#icmp_options ⇒ OCI::Core::Models::IcmpOptions
Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:
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.
30 31 32 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 30 def @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 ingress traffic allows TCP destination port 80, there should be an egress 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.
39 40 41 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 39 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. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
47 48 49 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 47 def protocol @protocol end |
#source ⇒ String
[Required] Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
Allowed values:
-
IP address range in CIDR notation. For example:
192.168.1.0/24
or2001:0db8:0123:45::/56
. Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses. -
The
cidrBlock
value for a Service, if you're setting up a security list rule for traffic coming from a particularService
through a service gateway. For example:oci-phx-objectstorage
.
63 64 65 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 63 def source @source end |
#source_type ⇒ String
Type of source for the rule. The default is CIDR_BLOCK
.
-
CIDR_BLOCK
: If the rule'ssource
is an IP address range in CIDR notation. -
SERVICE_CIDR_BLOCK
: If the rule'ssource
is thecidrBlock
value for a Service (the rule is for traffic coming from a particularService
through a service gateway).
74 75 76 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 74 def source_type @source_type 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.
80 81 82 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 80 def @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.
86 87 88 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 86 def @udp_options end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 94 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'icmp_options': :'icmpOptions', 'is_stateless': :'isStateless', 'protocol': :'protocol', 'source': :'source', 'source_type': :'sourceType', 'tcp_options': :'tcpOptions', 'udp_options': :'udpOptions', 'description': :'description' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 110 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'icmp_options': :'OCI::Core::Models::IcmpOptions', 'is_stateless': :'BOOLEAN', 'protocol': :'String', 'source': :'String', 'source_type': :'String', 'tcp_options': :'OCI::Core::Models::TcpOptions', 'udp_options': :'OCI::Core::Models::UdpOptions', 'description': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
204 205 206 207 208 209 210 211 212 213 214 215 216 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 204 def ==(other) return true if equal?(other) self.class == other.class && == other. && is_stateless == other.is_stateless && protocol == other.protocol && source == other.source && source_type == other.source_type && == other. && == other. && description == other.description end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 241 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
221 222 223 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 221 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
230 231 232 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 230 def hash [, is_stateless, protocol, source, source_type, , , description].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
274 275 276 277 278 279 280 281 282 283 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 274 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
268 269 270 |
# File 'lib/oci/core/models/ingress_security_rule.rb', line 268 def to_s to_hash.to_s end |