class OCI::LoadBalancer::Models::LoadBalancer
The properties that define a load balancer. For more information, see [Managing a Load Balancer](docs.cloud.oracle.com/Content/Balance/Tasks/managingloadbalancer.htm).
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](docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
For information about endpoints and signing API requests, see [About the API](docs.cloud.oracle.com/Content/API/Concepts/usingapi.htm). For information about available SDKs and tools, see [SDKS and Other Tools](docs.cloud.oracle.com/Content/API/Concepts/sdks.htm).
Constants
- LIFECYCLE_STATE_ENUM
Attributes
@return [Hash<String, OCI::LoadBalancer::Models::BackendSet>]
@return [Hash<String, OCI::LoadBalancer::Models::Certificate>]
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the load balancer. @return [String]
[Required] A user-friendly name. It does not have to be unique, and it is changeable.
Example: `example_load_balancer`
@return [String]
@return [Hash<String, OCI::LoadBalancer::Models::Hostname>]
[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the load balancer. @return [String]
An array of IP addresses.
@return [Array<OCI::LoadBalancer::Models::IpAddress>]
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](docs.cloud.oracle.com/Content/Network/Concepts/securitylists.htm). For more information about public and private load balancers, see [How Load Balancing Works](docs.cloud.oracle.com/Content/Balance/Concepts/balanceoverview.htm#how-load-balancing-works).
Example: `true`
@return [BOOLEAN]
[Required] The current state of the load balancer.
@return [String]
@return [Hash<String, OCI::LoadBalancer::Models::Listener>]
An array of NSG [OCIDs](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) 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"]
@return [Array<String>]
@return [Hash<String, OCI::LoadBalancer::Models::PathRouteSet>]
@return [Hash<String, OCI::LoadBalancer::Models::RoutingPolicy>]
@return [Hash<String, OCI::LoadBalancer::Models::RuleSet>]
@return [OCI::LoadBalancer::Models::ShapeDetails]
[Required] A template that determines the total pre-provisioned bandwidth (ingress plus egress). To get a list of available shapes, use the {#list_shapes list_shapes} operation.
Example: `100Mbps`
@return [String]
@return [Hash<String, OCI::LoadBalancer::Models::SSLCipherSuite>]
An array of subnet [OCIDs](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). @return [Array<String>]
[Required] The date and time the load balancer was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/load_balancer/models/load_balancer.rb, line 160 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [Array<OCI::LoadBalancer::Models::IpAddress>] :ip_addresses The value to assign to the {#ip_addresses} property @option attributes [String] :shape_name The value to assign to the {#shape_name} property @option attributes [OCI::LoadBalancer::Models::ShapeDetails] :shape_details The value to assign to the {#shape_details} property @option attributes [BOOLEAN] :is_private The value to assign to the {#is_private} property @option attributes [Array<String>] :subnet_ids The value to assign to the {#subnet_ids} property @option attributes [Array<String>] :network_security_group_ids The value to assign to the {#network_security_group_ids} property @option attributes [Hash<String, OCI::LoadBalancer::Models::Listener>] :listeners The value to assign to the {#listeners} property @option attributes [Hash<String, OCI::LoadBalancer::Models::Hostname>] :hostnames The value to assign to the {#hostnames} property @option attributes [Hash<String, OCI::LoadBalancer::Models::SSLCipherSuite>] :ssl_cipher_suites The value to assign to the {#ssl_cipher_suites} property @option attributes [Hash<String, OCI::LoadBalancer::Models::Certificate>] :certificates The value to assign to the {#certificates} property @option attributes [Hash<String, OCI::LoadBalancer::Models::BackendSet>] :backend_sets The value to assign to the {#backend_sets} property @option attributes [Hash<String, OCI::LoadBalancer::Models::PathRouteSet>] :path_route_sets The value to assign to the {#path_route_sets} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Hash<String, Hash<String, Object>>] :system_tags The value to assign to the {#system_tags} property @option attributes [Hash<String, OCI::LoadBalancer::Models::RuleSet>] :rule_sets The value to assign to the {#rule_sets} property @option attributes [Hash<String, OCI::LoadBalancer::Models::RoutingPolicy>] :routing_policies The value to assign to the {#routing_policies} property
# File lib/oci/load_balancer/models/load_balancer.rb, line 247 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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self.system_tags = 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
Attribute type mapping.
# File lib/oci/load_balancer/models/load_balancer.rb, line 190 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/load_balancer/models/load_balancer.rb, line 390 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 && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && system_tags == other.system_tags && rule_sets == other.rule_sets && routing_policies == other.routing_policies end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/load_balancer/models/load_balancer.rb, line 441 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/load_balancer/models/load_balancer.rb, line 421 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/load_balancer/models/load_balancer.rb, line 430 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, freeform_tags, defined_tags, system_tags, rule_sets, routing_policies].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/load_balancer/models/load_balancer.rb, line 374 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/load_balancer/models/load_balancer.rb, line 474 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/load_balancer/models/load_balancer.rb, line 468 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/load_balancer/models/load_balancer.rb, line 491 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end