Class: OCI::Healthchecks::Models::PingMonitor
- Inherits:
-
Object
- Object
- OCI::Healthchecks::Models::PingMonitor
- Defined in:
- lib/oci/healthchecks/models/ping_monitor.rb
Overview
A summary containing all of the mutable and immutable properties for a ping monitor.
Constant Summary collapse
- PROTOCOL_ENUM =
[ PROTOCOL_ICMP = 'ICMP'.freeze, PROTOCOL_TCP = 'TCP'.freeze, PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
The OCID of the compartment.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly and mutable name suitable for display in a user interface.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
The OCID of the resource.
-
#interval_in_seconds ⇒ Integer
The monitor interval in seconds.
-
#is_enabled ⇒ BOOLEAN
Enables or disables the monitor.
-
#port ⇒ Integer
The port on which to probe endpoints.
- #protocol ⇒ String
-
#results_url ⇒ String
A URL for fetching the probe results.
-
#targets ⇒ Array<String>
A list of targets (hostnames or IP addresses) of the probe.
-
#timeout_in_seconds ⇒ Integer
The probe timeout in seconds.
-
#vantage_point_names ⇒ Array<String>
A list of names of vantage points from which to execute the probe.
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 = {}) ⇒ PingMonitor
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 = {}) ⇒ PingMonitor
Initializes the object
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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 142 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.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.interval_in_seconds = attributes[:'intervalInSeconds'] if attributes[:'intervalInSeconds'] raise 'You cannot provide both :intervalInSeconds and :interval_in_seconds' if attributes.key?(:'intervalInSeconds') && attributes.key?(:'interval_in_seconds') self.interval_in_seconds = attributes[:'interval_in_seconds'] if attributes[:'interval_in_seconds'] self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil? self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isEnabled and :is_enabled' if attributes.key?(:'isEnabled') && attributes.key?(:'is_enabled') self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil? self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
The OCID of the compartment.
27 28 29 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 27 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`
79 80 81 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 79 def @defined_tags end |
#display_name ⇒ String
A user-friendly and mutable name suitable for display in a user interface.
54 55 56 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 54 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`
72 73 74 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 72 def @freeform_tags end |
#id ⇒ String
The OCID of the resource.
19 20 21 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 19 def id @id end |
#interval_in_seconds ⇒ Integer
The monitor interval in seconds. Valid values: 10, 30, and 60.
59 60 61 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 59 def interval_in_seconds @interval_in_seconds end |
#is_enabled ⇒ BOOLEAN
Enables or disables the monitor. Set to ‘true’ to launch monitoring.
64 65 66 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 64 def is_enabled @is_enabled end |
#port ⇒ Integer
The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
41 42 43 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 41 def port @port end |
#protocol ⇒ String
50 51 52 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 50 def protocol @protocol end |
#results_url ⇒ String
A URL for fetching the probe results.
23 24 25 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 23 def results_url @results_url end |
#targets ⇒ Array<String>
A list of targets (hostnames or IP addresses) of the probe.
31 32 33 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 31 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.
47 48 49 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 47 def timeout_in_seconds @timeout_in_seconds end |
#vantage_point_names ⇒ Array<String>
A list of names of vantage points from which to execute the probe.
35 36 37 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 35 def vantage_point_names @vantage_point_names end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 82 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', 'display_name': :'displayName', 'interval_in_seconds': :'intervalInSeconds', 'is_enabled': :'isEnabled', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 103 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', 'display_name': :'String', 'interval_in_seconds': :'Integer', 'is_enabled': :'BOOLEAN', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 233 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 && display_name == other.display_name && interval_in_seconds == other.interval_in_seconds && is_enabled == other.is_enabled && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 275 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
255 256 257 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 255 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
264 265 266 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 264 def hash [id, results_url, compartment_id, targets, vantage_point_names, port, timeout_in_seconds, protocol, display_name, interval_in_seconds, is_enabled, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
308 309 310 311 312 313 314 315 316 317 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 308 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
302 303 304 |
# File 'lib/oci/healthchecks/models/ping_monitor.rb', line 302 def to_s to_hash.to_s end |