Class: OCI::NetworkLoadBalancer::Models::NetworkLoadBalancer
- Inherits:
-
Object
- Object
- OCI::NetworkLoadBalancer::Models::NetworkLoadBalancer
- Defined in:
- lib/oci/network_load_balancer/models/network_load_balancer.rb
Overview
The properties that define a network load balancer. For more information, see Managing a network load balancer.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, contact an administrator. If you are an administrator who writes policies to give users access, then see Getting Started with Policies.
For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.
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_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- NLB_IP_VERSION_ENUM =
[ NLB_IP_VERSION_IPV4 = 'IPV4'.freeze, NLB_IP_VERSION_IPV4_AND_IPV6 = 'IPV4_AND_IPV6'.freeze, NLB_IP_VERSION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#backend_sets ⇒ Hash<String, OCI::NetworkLoadBalancer::Models::BackendSet>
Backend sets associated with the network load balancer.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the network load balancer.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name, which does not have to be unique, and can be changed.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the network load balancer.
-
#ip_addresses ⇒ Array<OCI::NetworkLoadBalancer::Models::IpAddress>
[Required] An array of IP addresses.
-
#is_preserve_source_destination ⇒ BOOLEAN
When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC.
-
#is_private ⇒ BOOLEAN
Whether the network load balancer has a virtual cloud network-local (private) IP address.
-
#lifecycle_details ⇒ String
A message describing the current state in more detail.
-
#lifecycle_state ⇒ String
[Required] The current state of the network load balancer.
-
#listeners ⇒ Hash<String, OCI::NetworkLoadBalancer::Models::Listener>
Listeners associated with the network load balancer.
-
#network_security_group_ids ⇒ Array<String>
An array of network security groups OCIDs associated with the network load balancer.
-
#nlb_ip_version ⇒ String
IP version associated with the NLB.
-
#subnet_id ⇒ String
[Required] The subnet in which the network load balancer is spawned OCIDs.".
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Key-value pair representing system tags' keys and values scoped to a namespace.
-
#time_created ⇒ DateTime
[Required] The date and time the network load balancer was created, in the format defined by RFC3339.
-
#time_updated ⇒ DateTime
The time the network load balancer was updated.
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 = {}) ⇒ NetworkLoadBalancer
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 = {}) ⇒ NetworkLoadBalancer
Initializes the object
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 236 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.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.nlb_ip_version = attributes[:'nlbIpVersion'] if attributes[:'nlbIpVersion'] self.nlb_ip_version = "IPV4" if nlb_ip_version.nil? && !attributes.key?(:'nlbIpVersion') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :nlbIpVersion and :nlb_ip_version' if attributes.key?(:'nlbIpVersion') && attributes.key?(:'nlb_ip_version') self.nlb_ip_version = attributes[:'nlb_ip_version'] if attributes[:'nlb_ip_version'] self.nlb_ip_version = "IPV4" if nlb_ip_version.nil? && !attributes.key?(:'nlbIpVersion') && !attributes.key?(:'nlb_ip_version') # rubocop:disable Style/StringLiterals 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.ip_addresses = attributes[:'ipAddresses'] if attributes[:'ipAddresses'] raise 'You cannot provide both :ipAddresses and :ip_addresses' if attributes.key?(:'ipAddresses') && attributes.key?(:'ip_addresses') self.ip_addresses = attributes[:'ip_addresses'] if attributes[:'ip_addresses'] self.is_private = attributes[:'isPrivate'] unless attributes[:'isPrivate'].nil? self.is_private = true if is_private.nil? && !attributes.key?(:'isPrivate') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isPrivate and :is_private' if attributes.key?(:'isPrivate') && attributes.key?(:'is_private') self.is_private = attributes[:'is_private'] unless attributes[:'is_private'].nil? self.is_private = true if is_private.nil? && !attributes.key?(:'isPrivate') && !attributes.key?(:'is_private') # rubocop:disable Style/StringLiterals self.is_preserve_source_destination = attributes[:'isPreserveSourceDestination'] unless attributes[:'isPreserveSourceDestination'].nil? self.is_preserve_source_destination = false if is_preserve_source_destination.nil? && !attributes.key?(:'isPreserveSourceDestination') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isPreserveSourceDestination and :is_preserve_source_destination' if attributes.key?(:'isPreserveSourceDestination') && attributes.key?(:'is_preserve_source_destination') self.is_preserve_source_destination = attributes[:'is_preserve_source_destination'] unless attributes[:'is_preserve_source_destination'].nil? self.is_preserve_source_destination = false if is_preserve_source_destination.nil? && !attributes.key?(:'isPreserveSourceDestination') && !attributes.key?(:'is_preserve_source_destination') # rubocop:disable Style/StringLiterals 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.network_security_group_ids = attributes[:'networkSecurityGroupIds'] if attributes[:'networkSecurityGroupIds'] raise 'You cannot provide both :networkSecurityGroupIds and :network_security_group_ids' if attributes.key?(:'networkSecurityGroupIds') && attributes.key?(:'network_security_group_ids') self.network_security_group_ids = attributes[:'network_security_group_ids'] if attributes[:'network_security_group_ids'] self.listeners = attributes[:'listeners'] if attributes[:'listeners'] self.backend_sets = attributes[:'backendSets'] if attributes[:'backendSets'] raise 'You cannot provide both :backendSets and :backend_sets' if attributes.key?(:'backendSets') && attributes.key?(:'backend_sets') self.backend_sets = attributes[:'backend_sets'] if attributes[:'backend_sets'] 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
#backend_sets ⇒ Hash<String, OCI::NetworkLoadBalancer::Models::BackendSet>
Backend sets associated with the network load balancer.
136 137 138 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 136 def backend_sets @backend_sets end |
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the network load balancer.
44 45 46 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 44 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
152 153 154 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 152 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name, which does not have to be unique, and can be changed.
Example: example_load_balancer
51 52 53 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 51 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
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\"}
144 145 146 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 144 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the network load balancer.
40 41 42 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 40 def id @id end |
#ip_addresses ⇒ Array<OCI::NetworkLoadBalancer::Models::IpAddress>
[Required] An array of IP addresses.
84 85 86 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 84 def ip_addresses @ip_addresses end |
#is_preserve_source_destination ⇒ BOOLEAN
When enabled, the skipSourceDestinationCheck parameter is automatically enabled on the load balancer VNIC. Packets are sent to the backend set without any changes to the source and destination IP.
107 108 109 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 107 def is_preserve_source_destination @is_preserve_source_destination end |
#is_private ⇒ BOOLEAN
Whether the network load balancer has a virtual cloud network-local (private) IP address.
If "true", then the service assigns a private IP address to the network load balancer.
If "false", then the service assigns a public IP address to the network load balancer.
A public network load balancer is accessible from the internet, depending the security list rules for your virtual cloudn network. For more information about public and private network load balancers, see How Network Load Balancing Works. This value is true by default.
Example: true
101 102 103 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 101 def is_private @is_private 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.
61 62 63 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 61 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the network load balancer.
55 56 57 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 55 def lifecycle_state @lifecycle_state end |
#listeners ⇒ Hash<String, OCI::NetworkLoadBalancer::Models::Listener>
Listeners associated with the network load balancer.
132 133 134 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 132 def listeners @listeners end |
#network_security_group_ids ⇒ Array<String>
An array of network security groups OCIDs associated with the network load balancer.
During the creation of the network load balancer, the service adds the new load balancer to the specified network security groups.
The benefits of associating the network load balancer with network security groups include:
-
Network security groups define network security rules to govern ingress and egress traffic for the network load balancer.
-
The network security rules of other resources can reference the network security groups associated with the network load balancer to ensure access.
Example: ["ocid1.nsg.oc1.phx.unique_ID"]
128 129 130 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 128 def network_security_group_ids @network_security_group_ids end |
#nlb_ip_version ⇒ String
IP version associated with the NLB.
65 66 67 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 65 def nlb_ip_version @nlb_ip_version end |
#subnet_id ⇒ String
[Required] The subnet in which the network load balancer is spawned OCIDs."
111 112 113 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 111 def subnet_id @subnet_id end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Key-value pair representing system tags' keys and values scoped to a namespace. Example: {\"bar-key\": \"value\"}
158 159 160 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 158 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time the network load balancer was created, in the format defined by RFC3339.
Example: 2020-05-01T21:10:29.600Z
72 73 74 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 72 def time_created @time_created end |
#time_updated ⇒ DateTime
The time the network load balancer was updated. An RFC3339 formatted date-time string.
Example: 2020-05-01T22:10:29.600Z
79 80 81 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 79 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 161 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'nlb_ip_version': :'nlbIpVersion', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'ip_addresses': :'ipAddresses', 'is_private': :'isPrivate', 'is_preserve_source_destination': :'isPreserveSourceDestination', 'subnet_id': :'subnetId', 'network_security_group_ids': :'networkSecurityGroupIds', 'listeners': :'listeners', 'backend_sets': :'backendSets', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 187 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'display_name': :'String', 'lifecycle_state': :'String', 'lifecycle_details': :'String', 'nlb_ip_version': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'ip_addresses': :'Array<OCI::NetworkLoadBalancer::Models::IpAddress>', 'is_private': :'BOOLEAN', 'is_preserve_source_destination': :'BOOLEAN', 'subnet_id': :'String', 'network_security_group_ids': :'Array<String>', 'listeners': :'Hash<String, OCI::NetworkLoadBalancer::Models::Listener>', 'backend_sets': :'Hash<String, OCI::NetworkLoadBalancer::Models::BackendSet>', '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.
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 382 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && display_name == other.display_name && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && nlb_ip_version == other.nlb_ip_version && time_created == other.time_created && time_updated == other.time_updated && ip_addresses == other.ip_addresses && is_private == other.is_private && is_preserve_source_destination == other.is_preserve_source_destination && subnet_id == other.subnet_id && network_security_group_ids == other.network_security_group_ids && listeners == other.listeners && backend_sets == other.backend_sets && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 429 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
409 410 411 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 409 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
418 419 420 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 418 def hash [id, compartment_id, display_name, lifecycle_state, lifecycle_details, nlb_ip_version, time_created, time_updated, ip_addresses, is_private, is_preserve_source_destination, subnet_id, network_security_group_ids, listeners, backend_sets, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
462 463 464 465 466 467 468 469 470 471 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 462 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
456 457 458 |
# File 'lib/oci/network_load_balancer/models/network_load_balancer.rb', line 456 def to_s to_hash.to_s end |