Class: OCI::NetworkLoadBalancer::Models::BackendSummary
- Inherits:
-
Object
- Object
- OCI::NetworkLoadBalancer::Models::BackendSummary
- Defined in:
- lib/oci/network_load_balancer/models/backend_summary.rb
Overview
The configuration of a backend server that is a member of a network load balancer backend set. For more information, see Managing Backend Servers.
Instance Attribute Summary collapse
-
#ip_address ⇒ String
The IP address of the backend server.
-
#is_backup ⇒ BOOLEAN
Whether the network load balancer should treat this server as a backup unit.
-
#is_drain ⇒ BOOLEAN
Whether the network load balancer should drain this server.
-
#is_offline ⇒ BOOLEAN
Whether the network load balancer should treat this server as offline.
-
#name ⇒ String
A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set.
-
#port ⇒ Integer
[Required] The communication port for the backend server.
-
#target_id ⇒ String
The IP OCID/Instance OCID associated with the backend server.
-
#weight ⇒ Integer
The network 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 = {}) ⇒ BackendSummary
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 = {}) ⇒ BackendSummary
Initializes the object
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 120 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.name = attributes[:'name'] if attributes[:'name'] 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.target_id = attributes[:'targetId'] if attributes[:'targetId'] raise 'You cannot provide both :targetId and :target_id' if attributes.key?(:'targetId') && attributes.key?(:'target_id') self.target_id = attributes[:'target_id'] if attributes[:'target_id'] self.port = attributes[:'port'] if attributes[:'port'] self.weight = attributes[:'weight'] if attributes[:'weight'] self.is_drain = attributes[:'isDrain'] unless attributes[:'isDrain'].nil? self.is_drain = false if is_drain.nil? && !attributes.key?(:'isDrain') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isDrain and :is_drain' if attributes.key?(:'isDrain') && attributes.key?(:'is_drain') self.is_drain = attributes[:'is_drain'] unless attributes[:'is_drain'].nil? self.is_drain = false if is_drain.nil? && !attributes.key?(:'isDrain') && !attributes.key?(:'is_drain') # rubocop:disable Style/StringLiterals self.is_backup = attributes[:'isBackup'] unless attributes[:'isBackup'].nil? self.is_backup = false if is_backup.nil? && !attributes.key?(:'isBackup') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isBackup and :is_backup' if attributes.key?(:'isBackup') && attributes.key?(:'is_backup') self.is_backup = attributes[:'is_backup'] unless attributes[:'is_backup'].nil? self.is_backup = false if is_backup.nil? && !attributes.key?(:'isBackup') && !attributes.key?(:'is_backup') # rubocop:disable Style/StringLiterals self.is_offline = attributes[:'isOffline'] unless attributes[:'isOffline'].nil? self.is_offline = false if is_offline.nil? && !attributes.key?(:'isOffline') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isOffline and :is_offline' if attributes.key?(:'isOffline') && attributes.key?(:'is_offline') self.is_offline = attributes[:'is_offline'] unless attributes[:'is_offline'].nil? self.is_offline = false if is_offline.nil? && !attributes.key?(:'isOffline') && !attributes.key?(:'is_offline') # rubocop:disable Style/StringLiterals end |
Instance Attribute Details
#ip_address ⇒ String
The IP address of the backend server. Example: 10.0.0.3
24 25 26 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 24 def ip_address @ip_address end |
#is_backup ⇒ BOOLEAN
Whether the network load balancer should treat this server as a backup unit. If true
, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as "isBackup" fail the health check policy.
Example: false
64 65 66 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 64 def is_backup @is_backup end |
#is_drain ⇒ BOOLEAN
Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic.
Example: false
56 57 58 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 56 def is_drain @is_drain end |
#is_offline ⇒ BOOLEAN
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: false
72 73 74 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 72 def is_offline @is_offline end |
#name ⇒ String
A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set.
Example: 10.0.0.3:8080
, or ocid1.privateip..oc1.<var><unique_ID></var>:443
or 10.0.0.3:0
18 19 20 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 18 def name @name end |
#port ⇒ Integer
[Required] The communication port for the backend server.
Example: 8080
37 38 39 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 37 def port @port end |
#target_id ⇒ String
The IP OCID/Instance OCID associated with the backend server. Example: ocid1.privateip..oc1.<var><unique_ID></var>
30 31 32 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 30 def target_id @target_id end |
#weight ⇒ Integer
The network 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 three times the number of new connections as a server weighted '1'. For more information about load balancing policies, see How Network Load Balancing Policies Work.
Example: 3
48 49 50 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 48 def weight @weight end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 75 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'ip_address': :'ipAddress', 'target_id': :'targetId', 'port': :'port', 'weight': :'weight', 'is_drain': :'isDrain', 'is_backup': :'isBackup', 'is_offline': :'isOffline' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 91 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'ip_address': :'String', 'target_id': :'String', 'port': :'Integer', 'weight': :'Integer', 'is_drain': :'BOOLEAN', 'is_backup': :'BOOLEAN', 'is_offline': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 176 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && ip_address == other.ip_address && target_id == other.target_id && port == other.port && weight == other.weight && is_drain == other.is_drain && is_backup == other.is_backup && is_offline == other.is_offline end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 213 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
193 194 195 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 193 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
202 203 204 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 202 def hash [name, ip_address, target_id, port, weight, is_drain, is_backup, is_offline].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
246 247 248 249 250 251 252 253 254 255 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 246 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
240 241 242 |
# File 'lib/oci/network_load_balancer/models/backend_summary.rb', line 240 def to_s to_hash.to_s end |