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](docs.us-phoenix-1.oraclecloud.com/Content/Balance/tasks/managingbackendservers.htm).
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.
Instance Method Summary collapse
-
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other_object) ⇒ 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
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 69 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} unless attributes[:'backup'].nil? self.backup = attributes[:'backup'] else self.backup = false end unless attributes[:'drain'].nil? self.drain = attributes[:'drain'] else self.drain = false end if attributes[:'ipAddress'] self.ip_address = attributes[:'ipAddress'] end raise 'You cannot provide both :ipAddress and :ip_address' if attributes.key?(:'ipAddress') && attributes.key?(:'ip_address') if attributes[:'ip_address'] self.ip_address = attributes[:'ip_address'] end unless attributes[:'offline'].nil? self.offline = attributes[:'offline'] else self.offline = false end if attributes[:'port'] self.port = attributes[:'port'] end if attributes[:'weight'] self.weight = attributes[:'weight'] end 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.
Example: ‘true`
17 18 19 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 17 def backup @backup end |
#drain ⇒ BOOLEAN
Whether the load balancer should drain this server. Servers marked "drain" receive no new incoming traffic.
Example: ‘true`
25 26 27 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 25 def drain @drain end |
#ip_address ⇒ String
[Required] The IP address of the backend server.
Example: ‘10.10.10.4`
32 33 34 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 32 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: ‘true`
40 41 42 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 40 def offline @offline end |
#port ⇒ Integer
[Required] The communication port for the backend server.
Example: ‘8080`
47 48 49 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 47 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](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/lbpolicies.htm).
Example: ‘3`
58 59 60 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 58 def weight @weight end |
Instance Method Details
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
115 116 117 118 119 120 121 122 123 124 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 115 def ==(other_object) return true if self.equal?(other_object) self.class == other_object.class && backup == other_object.backup && drain == other_object.drain && ip_address == other_object.ip_address && offline == other_object.offline && port == other_object.port && weight == other_object.weight end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 141 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) self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? self.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_object) ⇒ Boolean
128 129 130 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 128 def eql?(other_object) self == other_object end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
134 135 136 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 134 def hash [backup, drain, ip_address, offline, port, weight].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
166 167 168 169 170 171 172 173 174 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 166 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
160 161 162 |
# File 'lib/oci/load_balancer/models/create_backend_details.rb', line 160 def to_s to_hash.to_s end |