Class: OCI::LoadBalancer::Models::HealthChecker
- Inherits:
-
Object
- Object
- OCI::LoadBalancer::Models::HealthChecker
- Defined in:
- lib/oci/load_balancer/models/health_checker.rb
Overview
The health check policy configuration. For more information, see Editing Health Check Policies.
Instance Attribute Summary collapse
-
#interval_in_millis ⇒ Integer
The interval between health checks, in milliseconds.
-
#is_force_plain_text ⇒ BOOLEAN
Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
-
#port ⇒ Integer
[Required] The backend server port against which to run the health check.
-
#protocol ⇒ String
[Required] The protocol the health check must use; either HTTP or TCP.
-
#response_body_regex ⇒ String
[Required] A regular expression for parsing the response body from the backend server.
-
#retries ⇒ Integer
The number of retries to attempt before a backend server is considered "unhealthy".
-
#return_code ⇒ Integer
[Required] The status code a healthy backend server should return.
-
#timeout_in_millis ⇒ Integer
The maximum time, in milliseconds, to wait for a reply to a health check.
-
#url_path ⇒ String
The path against which to run the health check.
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 = {}) ⇒ HealthChecker
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 = {}) ⇒ HealthChecker
Initializes the object
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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 136 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.protocol = attributes[:'protocol'] if attributes[:'protocol'] self.url_path = attributes[:'urlPath'] if attributes[:'urlPath'] raise 'You cannot provide both :urlPath and :url_path' if attributes.key?(:'urlPath') && attributes.key?(:'url_path') self.url_path = attributes[:'url_path'] if attributes[:'url_path'] self.port = attributes[:'port'] if attributes[:'port'] self.return_code = attributes[:'returnCode'] if attributes[:'returnCode'] raise 'You cannot provide both :returnCode and :return_code' if attributes.key?(:'returnCode') && attributes.key?(:'return_code') self.return_code = attributes[:'return_code'] if attributes[:'return_code'] self.retries = attributes[:'retries'] if attributes[:'retries'] self.timeout_in_millis = attributes[:'timeoutInMillis'] if attributes[:'timeoutInMillis'] raise 'You cannot provide both :timeoutInMillis and :timeout_in_millis' if attributes.key?(:'timeoutInMillis') && attributes.key?(:'timeout_in_millis') self.timeout_in_millis = attributes[:'timeout_in_millis'] if attributes[:'timeout_in_millis'] self.interval_in_millis = attributes[:'intervalInMillis'] if attributes[:'intervalInMillis'] raise 'You cannot provide both :intervalInMillis and :interval_in_millis' if attributes.key?(:'intervalInMillis') && attributes.key?(:'interval_in_millis') self.interval_in_millis = attributes[:'interval_in_millis'] if attributes[:'interval_in_millis'] self.response_body_regex = attributes[:'responseBodyRegex'] if attributes[:'responseBodyRegex'] raise 'You cannot provide both :responseBodyRegex and :response_body_regex' if attributes.key?(:'responseBodyRegex') && attributes.key?(:'response_body_regex') self.response_body_regex = attributes[:'response_body_regex'] if attributes[:'response_body_regex'] self.is_force_plain_text = attributes[:'isForcePlainText'] unless attributes[:'isForcePlainText'].nil? self.is_force_plain_text = false if is_force_plain_text.nil? && !attributes.key?(:'isForcePlainText') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isForcePlainText and :is_force_plain_text' if attributes.key?(:'isForcePlainText') && attributes.key?(:'is_force_plain_text') self.is_force_plain_text = attributes[:'is_force_plain_text'] unless attributes[:'is_force_plain_text'].nil? self.is_force_plain_text = false if is_force_plain_text.nil? && !attributes.key?(:'isForcePlainText') && !attributes.key?(:'is_force_plain_text') # rubocop:disable Style/StringLiterals end |
Instance Attribute Details
#interval_in_millis ⇒ Integer
The interval between health checks, in milliseconds. The default is 10000 (10 seconds).
Example: 10000
64 65 66 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 64 def interval_in_millis @interval_in_millis end |
#is_force_plain_text ⇒ BOOLEAN
Specifies if health checks should always be done using plain text instead of depending on whether or not the associated backend set is using SSL.
If "true", health checks will be done using plain text even if the associated backend set is configured to use SSL.
If "false", health checks will be done using SSL encryption if the associated backend set is configured to use SSL. If the backend set is not so configured the health checks will be done using plain text.
Example: false
85 86 87 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 85 def is_force_plain_text @is_force_plain_text end |
#port ⇒ Integer
[Required] The backend server port against which to run the health check. If the port is not specified, the load balancer uses the port information from the Backend
object.
Example: 8080
33 34 35 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 33 def port @port end |
#protocol ⇒ String
[Required] The protocol the health check must use; either HTTP or TCP.
Example: HTTP
18 19 20 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 18 def protocol @protocol end |
#response_body_regex ⇒ String
[Required] A regular expression for parsing the response body from the backend server.
Example: ^((?!false).|\s)*$
71 72 73 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 71 def response_body_regex @response_body_regex end |
#retries ⇒ Integer
The number of retries to attempt before a backend server is considered "unhealthy". This number also applies when recovering a server to the "healthy" state. Defaults to 3.
Example: 3
49 50 51 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 49 def retries @retries end |
#return_code ⇒ Integer
[Required] The status code a healthy backend server should return. If you configure the health check policy to use the HTTP protocol, you can use common HTTP status codes such as "200".
Example: 200
41 42 43 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 41 def return_code @return_code end |
#timeout_in_millis ⇒ Integer
The maximum time, in milliseconds, to wait for a reply to a health check. A health check is successful only if a reply returns within this timeout period. Defaults to 3000 (3 seconds).
Example: 3000
57 58 59 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 57 def timeout_in_millis @timeout_in_millis end |
#url_path ⇒ String
The path against which to run the health check.
Example: /healthcheck
25 26 27 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 25 def url_path @url_path end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 88 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'protocol': :'protocol', 'url_path': :'urlPath', 'port': :'port', 'return_code': :'returnCode', 'retries': :'retries', 'timeout_in_millis': :'timeoutInMillis', 'interval_in_millis': :'intervalInMillis', 'response_body_regex': :'responseBodyRegex', 'is_force_plain_text': :'isForcePlainText' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 105 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'protocol': :'String', 'url_path': :'String', 'port': :'Integer', 'return_code': :'Integer', 'retries': :'Integer', 'timeout_in_millis': :'Integer', 'interval_in_millis': :'Integer', 'response_body_regex': :'String', 'is_force_plain_text': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 194 def ==(other) return true if equal?(other) self.class == other.class && protocol == other.protocol && url_path == other.url_path && port == other.port && return_code == other.return_code && retries == other.retries && timeout_in_millis == other.timeout_in_millis && interval_in_millis == other.interval_in_millis && response_body_regex == other.response_body_regex && is_force_plain_text == other.is_force_plain_text end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 232 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
212 213 214 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 212 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
221 222 223 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 221 def hash [protocol, url_path, port, return_code, retries, timeout_in_millis, interval_in_millis, response_body_regex, is_force_plain_text].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
265 266 267 268 269 270 271 272 273 274 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 265 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
259 260 261 |
# File 'lib/oci/load_balancer/models/health_checker.rb', line 259 def to_s to_hash.to_s end |