Class: OCI::LoadBalancer::Models::HealthCheckerDetails
- Inherits:
-
Object
- Object
- OCI::LoadBalancer::Models::HealthCheckerDetails
- Defined in:
- lib/oci/load_balancer/models/health_checker_details.rb
Overview
The health check policy’s configuration details.
Instance Attribute Summary collapse
-
#interval_in_millis ⇒ Integer
The interval between health checks, in milliseconds.
-
#port ⇒ Integer
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
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
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 = {}) ⇒ HealthCheckerDetails
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 = {}) ⇒ HealthCheckerDetails
Initializes the object
113 114 115 116 117 118 119 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 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 113 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'] end |
Instance Attribute Details
#interval_in_millis ⇒ Integer
The interval between health checks, in milliseconds.
Example: ‘10000`
58 59 60 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 58 def interval_in_millis @interval_in_millis end |
#port ⇒ Integer
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`
29 30 31 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 29 def port @port end |
#protocol ⇒ String
[Required] The protocol the health check must use; either HTTP or TCP.
Example: ‘HTTP`
14 15 16 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 14 def protocol @protocol end |
#response_body_regex ⇒ String
A regular expression for parsing the response body from the backend server.
Example: ‘^((?!false).|\s)*$`
65 66 67 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 65 def response_body_regex @response_body_regex end |
#retries ⇒ Integer
The number of retries to attempt before a backend server is considered "unhealthy".
Example: ‘3`
43 44 45 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 43 def retries @retries end |
#return_code ⇒ Integer
The status code a healthy backend server should return.
Example: ‘200`
36 37 38 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 36 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.
Example: ‘3000`
51 52 53 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 51 def timeout_in_millis @timeout_in_millis end |
#url_path ⇒ String
The path against which to run the health check.
Example: ‘/healthcheck`
21 22 23 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 21 def url_path @url_path end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 68 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' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 84 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' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 163 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 end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 200 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
180 181 182 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 180 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
189 190 191 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 189 def hash [protocol, url_path, port, return_code, retries, timeout_in_millis, interval_in_millis, response_body_regex].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
233 234 235 236 237 238 239 240 241 242 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 233 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
227 228 229 |
# File 'lib/oci/load_balancer/models/health_checker_details.rb', line 227 def to_s to_hash.to_s end |