Class: OCI::LoadBalancer::Models::CreateBackendDetails
- Inherits:
-
Object
- Object
- OCI::LoadBalancer::Models::CreateBackendDetails
- Defined in:
- lib/oci/load_balancer/models/create_backend_details.rb
Overview
The configuration details for creating a backend server in a backend set. For more information on backend server configuration, see Managing Backend Servers.
Instance Attribute Summary collapse
-
#backup ⇒ BOOLEAN
Whether the load balancer should treat this server as a backup unit.
-
#drain ⇒ BOOLEAN
Whether the load balancer should drain this server.
-
#ip_address ⇒ String
[Required] The IP address of the backend server.
-
#offline ⇒ BOOLEAN
Whether the load balancer should treat this server as offline.
-
#port ⇒ Integer
[Required] The communication port for the backend server.
-
#weight ⇒ Integer
The load balancing policy weight assigned to the server.
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 = {}) ⇒ CreateBackendDetails
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 = {}) ⇒ CreateBackendDetails
Initializes the object
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 105 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.ip_address = attributes[:'ipAddress'] if attributes[:'ipAddress'] raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address') self.ip_address = attributes[:'ip_address'] if attributes[:'ip_address'] self.port = attributes[:'port'] if attributes[:'port'] self.weight = attributes[:'weight'] if attributes[:'weight'] self.backup = attributes[:'backup'] unless attributes[:'backup'].nil? self.backup = false if backup.nil? && !attributes.key?(:'backup') # rubocop:disable Style/StringLiterals self.drain = attributes[:'drain'] unless attributes[:'drain'].nil? self.drain = false if drain.nil? && !attributes.key?(:'drain') # rubocop:disable Style/StringLiterals self.offline = attributes[:'offline'] unless attributes[:'offline'].nil? self.offline = false if offline.nil? && !attributes.key?(:'offline') # rubocop:disable Style/StringLiterals end |
Instance Attribute Details
#backup ⇒ BOOLEAN
Whether the load balancer should treat this server as a backup unit. If true
, the load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "backup" fail the health check policy.
Note: You cannot add a backend server marked as backup
to a backend set that uses the IP Hash policy.
Example: false
47 48 49 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 47 def backup @backup end |
#drain ⇒ BOOLEAN
Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic.
Example: false
55 56 57 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 55 def drain @drain end |
#ip_address ⇒ String
[Required] The IP address of the backend server.
Example: 10.0.0.3
19 20 21 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 19 def ip_address @ip_address end |
#offline ⇒ BOOLEAN
Whether the load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: false
63 64 65 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 63 def offline @offline end |
#port ⇒ Integer
[Required] The communication port for the backend server.
Example: 8080
26 27 28 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 26 def port @port end |
#weight ⇒ Integer
The load balancing policy weight assigned to the server. Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted '3' receives 3 times the number of new connections as a server weighted '1'. For more information on load balancing policies, see How Load Balancing Policies Work.
Example: 3
37 38 39 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 37 def weight @weight end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 66 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'ip_address': :'ipAddress', 'port': :'port', 'weight': :'weight', 'backup': :'backup', 'drain': :'drain', 'offline': :'offline' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 80 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'ip_address': :'String', 'port': :'Integer', 'weight': :'Integer', 'backup': :'BOOLEAN', 'drain': :'BOOLEAN', 'offline': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 138 def ==(other) return true if equal?(other) self.class == other.class && ip_address == other.ip_address && port == other.port && weight == other.weight && backup == other.backup && drain == other.drain && offline == other.offline end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 173 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
153 154 155 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 153 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
162 163 164 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 162 def hash [ip_address, port, weight, backup, drain, offline].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
206 207 208 209 210 211 212 213 214 215 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 206 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
200 201 202 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 200 def to_s to_hash.to_s end |