Class: OCI::Healthchecks::Models::HttpProbe
- Inherits:
-
Object
- Object
- OCI::Healthchecks::Models::HttpProbe
- Defined in:
- lib/oci/healthchecks/models/http_probe.rb
Overview
A summary that contains all of the mutable and immutable properties for an HTTP probe.
Constant Summary collapse
- PROTOCOL_ENUM =
rubocop:disable Metrics/LineLength
[ PROTOCOL_HTTP = 'HTTP'.freeze, PROTOCOL_HTTPS = 'HTTPS'.freeze, PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- METHOD_ENUM =
[ METHOD_GET = 'GET'.freeze, METHOD_HEAD = 'HEAD'.freeze, METHOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The OCID of the compartment.
-
#headers ⇒ Hash<String, String>
A dictionary of HTTP request headers.
-
#id ⇒ String
The OCID of the resource.
- #method ⇒ String
-
#path ⇒ String
The optional URL path to probe, including query parameters.
-
#port ⇒ Integer
The port on which to probe endpoints.
- #protocol ⇒ String
-
#results_url ⇒ String
A URL for fetching the probe results.
- #targets ⇒ Array<String>
-
#timeout_in_seconds ⇒ Integer
The probe timeout in seconds.
- #vantage_point_names ⇒ Array<String>
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 = {}) ⇒ HttpProbe
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 = {}) ⇒ HttpProbe
Initializes the object
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 168 169 170 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 125 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.id = attributes[:'id'] if attributes[:'id'] self.results_url = attributes[:'resultsUrl'] if attributes[:'resultsUrl'] raise 'You cannot provide both :resultsUrl and :results_url' if attributes.key?(:'resultsUrl') && attributes.key?(:'results_url') self.results_url = attributes[:'results_url'] if attributes[:'results_url'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.targets = attributes[:'targets'] if attributes[:'targets'] self.vantage_point_names = attributes[:'vantagePointNames'] if attributes[:'vantagePointNames'] raise 'You cannot provide both :vantagePointNames and :vantage_point_names' if attributes.key?(:'vantagePointNames') && attributes.key?(:'vantage_point_names') self.vantage_point_names = attributes[:'vantage_point_names'] if attributes[:'vantage_point_names'] self.port = attributes[:'port'] if attributes[:'port'] self.timeout_in_seconds = attributes[:'timeoutInSeconds'] if attributes[:'timeoutInSeconds'] raise 'You cannot provide both :timeoutInSeconds and :timeout_in_seconds' if attributes.key?(:'timeoutInSeconds') && attributes.key?(:'timeout_in_seconds') self.timeout_in_seconds = attributes[:'timeout_in_seconds'] if attributes[:'timeout_in_seconds'] self.protocol = attributes[:'protocol'] if attributes[:'protocol'] self.method = attributes[:'method'] if attributes[:'method'] self.method = "HEAD" if method.nil? && !attributes.key?(:'method') # rubocop:disable Style/StringLiterals self.path = attributes[:'path'] if attributes[:'path'] self.path = "/" if path.nil? && !attributes.key?(:'path') # rubocop:disable Style/StringLiterals self.headers = attributes[:'headers'] if attributes[:'headers'] end |
Instance Attribute Details
#compartment_id ⇒ String
The OCID of the compartment.
33 34 35 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 33 def compartment_id @compartment_id end |
#headers ⇒ Hash<String, String>
A dictionary of HTTP request headers.
Note: Monitors and probes do not support the use of the ‘Authorization` HTTP header.
68 69 70 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 68 def headers @headers end |
#id ⇒ String
The OCID of the resource.
25 26 27 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 25 def id @id end |
#method ⇒ String
57 58 59 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 57 def method @method end |
#path ⇒ String
The optional URL path to probe, including query parameters.
61 62 63 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 61 def path @path end |
#port ⇒ Integer
The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
45 46 47 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 45 def port @port end |
#protocol ⇒ String
54 55 56 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 54 def protocol @protocol end |
#results_url ⇒ String
A URL for fetching the probe results.
29 30 31 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 29 def results_url @results_url end |
#targets ⇒ Array<String>
36 37 38 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 36 def targets @targets end |
#timeout_in_seconds ⇒ Integer
The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to ‘intervalInSeconds` for monitors.
51 52 53 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 51 def timeout_in_seconds @timeout_in_seconds end |
#vantage_point_names ⇒ Array<String>
39 40 41 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 39 def vantage_point_names @vantage_point_names end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 71 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'results_url': :'resultsUrl', 'compartment_id': :'compartmentId', 'targets': :'targets', 'vantage_point_names': :'vantagePointNames', 'port': :'port', 'timeout_in_seconds': :'timeoutInSeconds', 'protocol': :'protocol', 'method': :'method', 'path': :'path', 'headers': :'headers' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 90 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'results_url': :'String', 'compartment_id': :'String', 'targets': :'Array<String>', 'vantage_point_names': :'Array<String>', 'port': :'Integer', 'timeout_in_seconds': :'Integer', 'protocol': :'String', 'method': :'String', 'path': :'String', 'headers': :'Hash<String, String>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 209 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && results_url == other.results_url && compartment_id == other.compartment_id && targets == other.targets && vantage_point_names == other.vantage_point_names && port == other.port && timeout_in_seconds == other.timeout_in_seconds && protocol == other.protocol && method == other.method && path == other.path && headers == other.headers end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 249 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
229 230 231 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 229 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
238 239 240 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 238 def hash [id, results_url, compartment_id, targets, vantage_point_names, port, timeout_in_seconds, protocol, method, path, headers].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
282 283 284 285 286 287 288 289 290 291 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 282 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
276 277 278 |
# File 'lib/oci/healthchecks/models/http_probe.rb', line 276 def to_s to_hash.to_s end |