Class: OCI::NetworkFirewall::Models::NetworkFirewallSummary
- Inherits:
-
Object
- Object
- OCI::NetworkFirewall::Models::NetworkFirewallSummary
- Defined in:
- lib/oci/network_firewall/models/network_firewall_summary.rb
Overview
Summary of the Network Firewall.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze, LIFECYCLE_STATE_ATTACHING = 'ATTACHING'.freeze, LIFECYCLE_STATE_DETACHING = 'DETACHING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
Availability Domain where Network Firewall instance is created.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the Network Firewall.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
[Required] Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name for the Network Firewall.
-
#freeform_tags ⇒ Hash<String, String>
[Required] Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the Network Firewall resource.
-
#ipv4_address ⇒ String
IPv4 address for the Network Firewall.
-
#ipv6_address ⇒ String
IPv6 address for the Network Firewall.
-
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
[Required] The current state of the Network Firewall.
-
#network_firewall_policy_id ⇒ String
[Required] The OCID of the Network Firewall Policy.
-
#subnet_id ⇒ String
[Required] The OCID of the subnet associated with the Network Firewall.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
[Required] The time instant at which the Network Firewall was created in the format defined by RFC3339.
-
#time_updated ⇒ DateTime
The time instant at which the Network Firewall was updated in the format defined by RFC3339.
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 = {}) ⇒ NetworkFirewallSummary
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 = {}) ⇒ NetworkFirewallSummary
Initializes the object
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 167 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.id = attributes[:'id'] if attributes[:'id'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId'] raise 'You cannot provide both :subnetId and :subnet_id' if attributes.key?(:'subnetId') && attributes.key?(:'subnet_id') self.subnet_id = attributes[:'subnet_id'] if attributes[:'subnet_id'] self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain'] raise 'You cannot provide both :availabilityDomain and :availability_domain' if attributes.key?(:'availabilityDomain') && attributes.key?(:'availability_domain') self.availability_domain = attributes[:'availability_domain'] if attributes[:'availability_domain'] self.ipv4_address = attributes[:'ipv4Address'] if attributes[:'ipv4Address'] raise 'You cannot provide both :ipv4Address and :ipv4_address' if attributes.key?(:'ipv4Address') && attributes.key?(:'ipv4_address') self.ipv4_address = attributes[:'ipv4_address'] if attributes[:'ipv4_address'] self.ipv6_address = attributes[:'ipv6Address'] if attributes[:'ipv6Address'] raise 'You cannot provide both :ipv6Address and :ipv6_address' if attributes.key?(:'ipv6Address') && attributes.key?(:'ipv6_address') self.ipv6_address = attributes[:'ipv6_address'] if attributes[:'ipv6_address'] self.network_firewall_policy_id = attributes[:'networkFirewallPolicyId'] if attributes[:'networkFirewallPolicyId'] raise 'You cannot provide both :networkFirewallPolicyId and :network_firewall_policy_id' if attributes.key?(:'networkFirewallPolicyId') && attributes.key?(:'network_firewall_policy_id') self.network_firewall_policy_id = attributes[:'network_firewall_policy_id'] if attributes[:'network_firewall_policy_id'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails'] raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details') self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#availability_domain ⇒ String
Availability Domain where Network Firewall instance is created. To get a list of availability domains for a tenancy, use list_availability_domains operation. Example: kIdk:PHX-AD-1
46 47 48 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 46 def availability_domain @availability_domain end |
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the Network Firewall.
31 32 33 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 31 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}
92 93 94 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 92 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.
35 36 37 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 35 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}
85 86 87 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 85 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the Network Firewall resource.
27 28 29 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 27 def id @id end |
#ipv4_address ⇒ String
IPv4 address for the Network Firewall.
50 51 52 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 50 def ipv4_address @ipv4_address end |
#ipv6_address ⇒ String
IPv6 address for the Network Firewall.
54 55 56 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 54 def ipv6_address @ipv6_address end |
#lifecycle_details ⇒ String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
78 79 80 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 78 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the Network Firewall.
74 75 76 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 74 def lifecycle_state @lifecycle_state end |
#network_firewall_policy_id ⇒ String
[Required] The OCID of the Network Firewall Policy.
58 59 60 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 58 def network_firewall_policy_id @network_firewall_policy_id end |
#subnet_id ⇒ String
[Required] The OCID of the subnet associated with the Network Firewall.
39 40 41 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 39 def subnet_id @subnet_id end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
98 99 100 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 98 def @system_tags end |
#time_created ⇒ DateTime
[Required] The time instant at which the Network Firewall was created in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
64 65 66 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 64 def time_created @time_created end |
#time_updated ⇒ DateTime
The time instant at which the Network Firewall was updated in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
70 71 72 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 70 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 101 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'subnet_id': :'subnetId', 'availability_domain': :'availabilityDomain', 'ipv4_address': :'ipv4Address', 'ipv6_address': :'ipv6Address', 'network_firewall_policy_id': :'networkFirewallPolicyId', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 124 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'display_name': :'String', 'subnet_id': :'String', 'availability_domain': :'String', 'ipv4_address': :'String', 'ipv6_address': :'String', 'network_firewall_policy_id': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 280 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && display_name == other.display_name && subnet_id == other.subnet_id && availability_domain == other.availability_domain && ipv4_address == other.ipv4_address && ipv6_address == other.ipv6_address && network_firewall_policy_id == other.network_firewall_policy_id && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 324 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
304 305 306 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 304 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
313 314 315 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 313 def hash [id, compartment_id, display_name, subnet_id, availability_domain, ipv4_address, ipv6_address, network_firewall_policy_id, time_created, time_updated, lifecycle_state, lifecycle_details, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
357 358 359 360 361 362 363 364 365 366 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 357 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
351 352 353 |
# File 'lib/oci/network_firewall/models/network_firewall_summary.rb', line 351 def to_s to_hash.to_s end |