Class: OCI::LoadBalancer::Models::LoadBalancer
- Inherits:
-
Object
- Object
- OCI::LoadBalancer::Models::LoadBalancer
- Defined in:
- lib/oci/load_balancer/models/load_balancer.rb
Overview
The properties that define a load balancer. For more information, see Managing a Load Balancer.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, 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_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
- #backend_sets ⇒ Hash<String, OCI::LoadBalancer::Models::BackendSet>
- #certificates ⇒ Hash<String, OCI::LoadBalancer::Models::Certificate>
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the load balancer.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
- #hostnames ⇒ Hash<String, OCI::LoadBalancer::Models::Hostname>
-
#id ⇒ String
[Required] The OCID of the load balancer.
-
#ip_addresses ⇒ Array<OCI::LoadBalancer::Models::IpAddress>
An array of IP addresses.
-
#is_private ⇒ BOOLEAN
Whether the load balancer has a VCN-local (private) IP address.
-
#lifecycle_state ⇒ String
[Required] The current state of the load balancer.
- #listeners ⇒ Hash<String, OCI::LoadBalancer::Models::Listener>
-
#network_security_group_ids ⇒ Array<String>
An array of NSG OCIDs associated with the load balancer.
- #path_route_sets ⇒ Hash<String, OCI::LoadBalancer::Models::PathRouteSet>
- #routing_policies ⇒ Hash<String, OCI::LoadBalancer::Models::RoutingPolicy>
- #rule_sets ⇒ Hash<String, OCI::LoadBalancer::Models::RuleSet>
- #shape_details ⇒ OCI::LoadBalancer::Models::ShapeDetails
-
#shape_name ⇒ String
[Required] A template that determines the total pre-provisioned bandwidth (ingress plus egress).
- #ssl_cipher_suites ⇒ Hash<String, OCI::LoadBalancer::Models::SSLCipherSuite>
-
#subnet_ids ⇒ Array<String>
An array of subnet OCIDs.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource.
-
#time_created ⇒ DateTime
[Required] The date and time the load balancer was created, 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 = {}) ⇒ LoadBalancer
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 = {}) ⇒ LoadBalancer
Initializes the object
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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 248 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.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.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.shape_name = attributes[:'shapeName'] if attributes[:'shapeName'] raise 'You cannot provide both :shapeName and :shape_name' if attributes.key?(:'shapeName') && attributes.key?(:'shape_name') self.shape_name = attributes[:'shape_name'] if attributes[:'shape_name'] self.shape_details = attributes[:'shapeDetails'] if attributes[:'shapeDetails'] raise 'You cannot provide both :shapeDetails and :shape_details' if attributes.key?(:'shapeDetails') && attributes.key?(:'shape_details') self.shape_details = attributes[:'shape_details'] if attributes[:'shape_details'] self.is_private = attributes[:'isPrivate'] unless attributes[:'isPrivate'].nil? 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.subnet_ids = attributes[:'subnetIds'] if attributes[:'subnetIds'] raise 'You cannot provide both :subnetIds and :subnet_ids' if attributes.key?(:'subnetIds') && attributes.key?(:'subnet_ids') self.subnet_ids = attributes[:'subnet_ids'] if attributes[:'subnet_ids'] 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.hostnames = attributes[:'hostnames'] if attributes[:'hostnames'] self.ssl_cipher_suites = attributes[:'sslCipherSuites'] if attributes[:'sslCipherSuites'] raise 'You cannot provide both :sslCipherSuites and :ssl_cipher_suites' if attributes.key?(:'sslCipherSuites') && attributes.key?(:'ssl_cipher_suites') self.ssl_cipher_suites = attributes[:'ssl_cipher_suites'] if attributes[:'ssl_cipher_suites'] self.certificates = attributes[:'certificates'] if attributes[:'certificates'] 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.path_route_sets = attributes[:'pathRouteSets'] if attributes[:'pathRouteSets'] raise 'You cannot provide both :pathRouteSets and :path_route_sets' if attributes.key?(:'pathRouteSets') && attributes.key?(:'path_route_sets') self.path_route_sets = attributes[:'path_route_sets'] if attributes[:'path_route_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'] self.rule_sets = attributes[:'ruleSets'] if attributes[:'ruleSets'] raise 'You cannot provide both :ruleSets and :rule_sets' if attributes.key?(:'ruleSets') && attributes.key?(:'rule_sets') self.rule_sets = attributes[:'rule_sets'] if attributes[:'rule_sets'] self.routing_policies = attributes[:'routingPolicies'] if attributes[:'routingPolicies'] raise 'You cannot provide both :routingPolicies and :routing_policies' if attributes.key?(:'routingPolicies') && attributes.key?(:'routing_policies') self.routing_policies = attributes[:'routing_policies'] if attributes[:'routing_policies'] end |
Instance Attribute Details
#backend_sets ⇒ Hash<String, OCI::LoadBalancer::Models::BackendSet>
124 125 126 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 124 def backend_sets @backend_sets end |
#certificates ⇒ Hash<String, OCI::LoadBalancer::Models::Certificate>
121 122 123 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 121 def certificates @certificates end |
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the load balancer.
37 38 39 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 37 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\"}}
143 144 145 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 143 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name. It does not have to be unique, and it is changeable.
Example: example_load_balancer
44 45 46 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 44 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\"}
135 136 137 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 135 def @freeform_tags end |
#hostnames ⇒ Hash<String, OCI::LoadBalancer::Models::Hostname>
115 116 117 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 115 def hostnames @hostnames end |
#id ⇒ String
[Required] The OCID of the load balancer.
33 34 35 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 33 def id @id end |
#ip_addresses ⇒ Array<OCI::LoadBalancer::Models::IpAddress>
An array of IP addresses.
61 62 63 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 61 def ip_addresses @ip_addresses end |
#is_private ⇒ BOOLEAN
Whether the load balancer has a VCN-local (private) IP address.
If "true", the service assigns a private IP address to the load balancer.
If "false", the service assigns a public IP address to the load balancer.
A public load balancer is accessible from the internet, depending on your VCN's security list rules. For more information about public and private load balancers, see How Load Balancing Works.
Example: true
88 89 90 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 88 def is_private @is_private end |
#lifecycle_state ⇒ String
[Required] The current state of the load balancer.
49 50 51 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 49 def lifecycle_state @lifecycle_state end |
#listeners ⇒ Hash<String, OCI::LoadBalancer::Models::Listener>
112 113 114 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 112 def listeners @listeners end |
#network_security_group_ids ⇒ Array<String>
An array of NSG OCIDs associated with the load balancer.
During the load balancer's creation, the service adds the new load balancer to the specified NSGs.
The benefits of associating the load balancer with NSGs include:
-
NSGs define network security rules to govern ingress and egress traffic for the load balancer.
-
The network security rules of other resources can reference the NSGs associated with the load balancer to ensure access.
Example: ["ocid1.nsg.oc1.phx.unique_ID"]
109 110 111 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 109 def network_security_group_ids @network_security_group_ids end |
#path_route_sets ⇒ Hash<String, OCI::LoadBalancer::Models::PathRouteSet>
127 128 129 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 127 def path_route_sets @path_route_sets end |
#routing_policies ⇒ Hash<String, OCI::LoadBalancer::Models::RoutingPolicy>
158 159 160 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 158 def routing_policies @routing_policies end |
#rule_sets ⇒ Hash<String, OCI::LoadBalancer::Models::RuleSet>
155 156 157 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 155 def rule_sets @rule_sets end |
#shape_details ⇒ OCI::LoadBalancer::Models::ShapeDetails
73 74 75 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 73 def shape_details @shape_details end |
#shape_name ⇒ String
[Required] A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the list_shapes operation.
Example: 100Mbps
70 71 72 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 70 def shape_name @shape_name end |
#ssl_cipher_suites ⇒ Hash<String, OCI::LoadBalancer::Models::SSLCipherSuite>
118 119 120 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 118 def ssl_cipher_suites @ssl_cipher_suites end |
#subnet_ids ⇒ Array<String>
An array of subnet OCIDs.
92 93 94 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 92 def subnet_ids @subnet_ids end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.
Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
152 153 154 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 152 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time the load balancer was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
56 57 58 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 56 def time_created @time_created 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 185 186 187 188 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 161 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'ip_addresses': :'ipAddresses', 'shape_name': :'shapeName', 'shape_details': :'shapeDetails', 'is_private': :'isPrivate', 'subnet_ids': :'subnetIds', 'network_security_group_ids': :'networkSecurityGroupIds', 'listeners': :'listeners', 'hostnames': :'hostnames', 'ssl_cipher_suites': :'sslCipherSuites', 'certificates': :'certificates', 'backend_sets': :'backendSets', 'path_route_sets': :'pathRouteSets', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags', 'rule_sets': :'ruleSets', 'routing_policies': :'routingPolicies' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 191 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'display_name': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'ip_addresses': :'Array<OCI::LoadBalancer::Models::IpAddress>', 'shape_name': :'String', 'shape_details': :'OCI::LoadBalancer::Models::ShapeDetails', 'is_private': :'BOOLEAN', 'subnet_ids': :'Array<String>', 'network_security_group_ids': :'Array<String>', 'listeners': :'Hash<String, OCI::LoadBalancer::Models::Listener>', 'hostnames': :'Hash<String, OCI::LoadBalancer::Models::Hostname>', 'ssl_cipher_suites': :'Hash<String, OCI::LoadBalancer::Models::SSLCipherSuite>', 'certificates': :'Hash<String, OCI::LoadBalancer::Models::Certificate>', 'backend_sets': :'Hash<String, OCI::LoadBalancer::Models::BackendSet>', 'path_route_sets': :'Hash<String, OCI::LoadBalancer::Models::PathRouteSet>', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>', 'rule_sets': :'Hash<String, OCI::LoadBalancer::Models::RuleSet>', 'routing_policies': :'Hash<String, OCI::LoadBalancer::Models::RoutingPolicy>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 391 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 && time_created == other.time_created && ip_addresses == other.ip_addresses && shape_name == other.shape_name && shape_details == other.shape_details && is_private == other.is_private && subnet_ids == other.subnet_ids && network_security_group_ids == other.network_security_group_ids && listeners == other.listeners && hostnames == other.hostnames && ssl_cipher_suites == other.ssl_cipher_suites && certificates == other.certificates && backend_sets == other.backend_sets && path_route_sets == other.path_route_sets && == other. && == other. && == other. && rule_sets == other.rule_sets && routing_policies == other.routing_policies end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 442 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
422 423 424 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 422 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
431 432 433 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 431 def hash [id, compartment_id, display_name, lifecycle_state, time_created, ip_addresses, shape_name, shape_details, is_private, subnet_ids, network_security_group_ids, listeners, hostnames, ssl_cipher_suites, certificates, backend_sets, path_route_sets, , , , rule_sets, routing_policies].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
475 476 477 478 479 480 481 482 483 484 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 475 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
469 470 471 |
# File 'lib/oci/load_balancer/models/load_balancer.rb', line 469 def to_s to_hash.to_s end |