class OCI::NetworkLoadBalancer::Models::CreateBackendDetails
The configuration of a backend server that is a member of a network load balancer backend set. For more information, see [Managing Backend Servers](docs.cloud.oracle.com/Content/Balance/Tasks/managingbackendservers.htm).
Attributes
The IP address of the backend server. Example: `10.0.0.3`
@return [String]
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`
@return [BOOLEAN]
Whether the network load balancer should drain this server. Servers marked "isDrain" receive no incoming traffic.
Example: `false`
@return [BOOLEAN]
Whether the network load balancer should treat this server as offline. Offline servers receive no incoming traffic.
Example: `false`
@return [BOOLEAN]
Optional unique name identifying the backend within the backend set. If not specified, then one will be generated. Example: `webServer1`
@return [String]
[Required] The communication port for the backend server.
Example: `8080`
@return [Integer]
The IP OCID/Instance OCID associated with the backend server. Example: `ocid1.privateip..oc1.<var><unique_ID></var>`
@return [String]
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](docs.cloud.oracle.com/Content/Balance/Reference/lbpolicies.htm).
Example: `3`
@return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/network_load_balancer/models/create_backend_details.rb, line 73 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :ip_address The value to assign to the {#ip_address} property @option attributes [String] :target_id The value to assign to the {#target_id} property @option attributes [Integer] :port The value to assign to the {#port} property @option attributes [Integer] :weight The value to assign to the {#weight} property @option attributes [BOOLEAN] :is_drain The value to assign to the {#is_drain} property @option attributes [BOOLEAN] :is_backup The value to assign to the {#is_backup} property @option attributes [BOOLEAN] :is_offline The value to assign to the {#is_offline} property
# File lib/oci/network_load_balancer/models/create_backend_details.rb, line 118 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
Attribute type mapping.
# File lib/oci/network_load_balancer/models/create_backend_details.rb, line 89 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/network_load_balancer/models/create_backend_details.rb, line 174 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/network_load_balancer/models/create_backend_details.rb, line 211 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/network_load_balancer/models/create_backend_details.rb, line 191 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/network_load_balancer/models/create_backend_details.rb, line 200 def hash [name, ip_address, target_id, port, weight, is_drain, is_backup, is_offline].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/network_load_balancer/models/create_backend_details.rb, line 244 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/network_load_balancer/models/create_backend_details.rb, line 238 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/network_load_balancer/models/create_backend_details.rb, line 261 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