Class: OCI::ApmSynthetics::Models::MonitorSummary
- Inherits:
-
Object
- Object
- OCI::ApmSynthetics::Models::MonitorSummary
- Defined in:
- lib/oci/apm_synthetics/models/monitor_summary.rb
Overview
Information about the monitor.
Constant Summary collapse
- MONITOR_TYPE_ENUM =
[ MONITOR_TYPE_SCRIPTED_BROWSER = 'SCRIPTED_BROWSER'.freeze, MONITOR_TYPE_BROWSER = 'BROWSER'.freeze, MONITOR_TYPE_SCRIPTED_REST = 'SCRIPTED_REST'.freeze, MONITOR_TYPE_REST = 'REST'.freeze, MONITOR_TYPE_NETWORK = 'NETWORK'.freeze, MONITOR_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- STATUS_ENUM =
[ STATUS_ENABLED = 'ENABLED'.freeze, STATUS_DISABLED = 'DISABLED'.freeze, STATUS_INVALID = 'INVALID'.freeze, STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- SCHEDULING_POLICY_ENUM =
[ SCHEDULING_POLICY_ALL = 'ALL'.freeze, SCHEDULING_POLICY_ROUND_ROBIN = 'ROUND_ROBIN'.freeze, SCHEDULING_POLICY_BATCHED_ROUND_ROBIN = 'BATCHED_ROUND_ROBIN'.freeze, SCHEDULING_POLICY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#batch_interval_in_seconds ⇒ Integer
[Required] Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] Unique name that can be edited.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the monitor.
-
#is_run_now ⇒ BOOLEAN
[Required] If isRunNow is enabled, then the monitor will run immediately.
-
#is_run_once ⇒ BOOLEAN
[Required] If runOnce is enabled, then the monitor will run once.
- #maintenance_window_schedule ⇒ OCI::ApmSynthetics::Models::MaintenanceWindowSchedule
-
#monitor_type ⇒ String
[Required] The type of monitor.
-
#repeat_interval_in_seconds ⇒ Integer
[Required] Interval in seconds after the start time when the job should be repeated.
-
#scheduling_policy ⇒ String
[Required] Scheduling policy to decide the distribution of monitor executions on vantage points.
-
#script_id ⇒ String
[Required] The OCID of the script.
-
#script_name ⇒ String
[Required] Name of the script.
-
#status ⇒ String
[Required] Enables or disables the monitor.
-
#target ⇒ String
Specify the endpoint on which to run the monitor.
-
#time_created ⇒ DateTime
The time the resource was created, expressed in RFC 3339 timestamp format.
-
#time_updated ⇒ DateTime
The time the resource was updated, expressed in RFC 3339 timestamp format.
-
#timeout_in_seconds ⇒ Integer
[Required] Timeout in seconds.
-
#vantage_point_count ⇒ Integer
[Required] Number of vantage points where monitor is running.
-
#vantage_points ⇒ Array<OCI::ApmSynthetics::Models::VantagePointInfo>
[Required] List of public and dedicated vantage points where the monitor is running.
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 = {}) ⇒ MonitorSummary
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 = {}) ⇒ MonitorSummary
Initializes the object
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 219 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.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.monitor_type = attributes[:'monitorType'] if attributes[:'monitorType'] raise 'You cannot provide both :monitorType and :monitor_type' if attributes.key?(:'monitorType') && attributes.key?(:'monitor_type') self.monitor_type = attributes[:'monitor_type'] if attributes[:'monitor_type'] self.vantage_points = attributes[:'vantagePoints'] if attributes[:'vantagePoints'] raise 'You cannot provide both :vantagePoints and :vantage_points' if attributes.key?(:'vantagePoints') && attributes.key?(:'vantage_points') self.vantage_points = attributes[:'vantage_points'] if attributes[:'vantage_points'] self.vantage_point_count = attributes[:'vantagePointCount'] if attributes[:'vantagePointCount'] raise 'You cannot provide both :vantagePointCount and :vantage_point_count' if attributes.key?(:'vantagePointCount') && attributes.key?(:'vantage_point_count') self.vantage_point_count = attributes[:'vantage_point_count'] if attributes[:'vantage_point_count'] self.script_id = attributes[:'scriptId'] if attributes[:'scriptId'] raise 'You cannot provide both :scriptId and :script_id' if attributes.key?(:'scriptId') && attributes.key?(:'script_id') self.script_id = attributes[:'script_id'] if attributes[:'script_id'] self.script_name = attributes[:'scriptName'] if attributes[:'scriptName'] raise 'You cannot provide both :scriptName and :script_name' if attributes.key?(:'scriptName') && attributes.key?(:'script_name') self.script_name = attributes[:'script_name'] if attributes[:'script_name'] self.status = attributes[:'status'] if attributes[:'status'] self.repeat_interval_in_seconds = attributes[:'repeatIntervalInSeconds'] if attributes[:'repeatIntervalInSeconds'] raise 'You cannot provide both :repeatIntervalInSeconds and :repeat_interval_in_seconds' if attributes.key?(:'repeatIntervalInSeconds') && attributes.key?(:'repeat_interval_in_seconds') self.repeat_interval_in_seconds = attributes[:'repeat_interval_in_seconds'] if attributes[:'repeat_interval_in_seconds'] self.is_run_once = attributes[:'isRunOnce'] unless attributes[:'isRunOnce'].nil? self.is_run_once = false if is_run_once.nil? && !attributes.key?(:'isRunOnce') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isRunOnce and :is_run_once' if attributes.key?(:'isRunOnce') && attributes.key?(:'is_run_once') self.is_run_once = attributes[:'is_run_once'] unless attributes[:'is_run_once'].nil? self.is_run_once = false if is_run_once.nil? && !attributes.key?(:'isRunOnce') && !attributes.key?(:'is_run_once') # rubocop:disable Style/StringLiterals 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.target = attributes[:'target'] if attributes[:'target'] self.maintenance_window_schedule = attributes[:'maintenanceWindowSchedule'] if attributes[:'maintenanceWindowSchedule'] raise 'You cannot provide both :maintenanceWindowSchedule and :maintenance_window_schedule' if attributes.key?(:'maintenanceWindowSchedule') && attributes.key?(:'maintenance_window_schedule') self.maintenance_window_schedule = attributes[:'maintenance_window_schedule'] if attributes[:'maintenance_window_schedule'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated'] raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated') self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated'] 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'] self.is_run_now = attributes[:'isRunNow'] unless attributes[:'isRunNow'].nil? self.is_run_now = false if is_run_now.nil? && !attributes.key?(:'isRunNow') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isRunNow and :is_run_now' if attributes.key?(:'isRunNow') && attributes.key?(:'is_run_now') self.is_run_now = attributes[:'is_run_now'] unless attributes[:'is_run_now'].nil? self.is_run_now = false if is_run_now.nil? && !attributes.key?(:'isRunNow') && !attributes.key?(:'is_run_now') # rubocop:disable Style/StringLiterals self.scheduling_policy = attributes[:'schedulingPolicy'] if attributes[:'schedulingPolicy'] raise 'You cannot provide both :schedulingPolicy and :scheduling_policy' if attributes.key?(:'schedulingPolicy') && attributes.key?(:'scheduling_policy') self.scheduling_policy = attributes[:'scheduling_policy'] if attributes[:'scheduling_policy'] self.batch_interval_in_seconds = attributes[:'batchIntervalInSeconds'] if attributes[:'batchIntervalInSeconds'] raise 'You cannot provide both :batchIntervalInSeconds and :batch_interval_in_seconds' if attributes.key?(:'batchIntervalInSeconds') && attributes.key?(:'batch_interval_in_seconds') self.batch_interval_in_seconds = attributes[:'batch_interval_in_seconds'] if attributes[:'batch_interval_in_seconds'] end |
Instance Attribute Details
#batch_interval_in_seconds ⇒ Integer
[Required] Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
135 136 137 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 135 def batch_interval_in_seconds @batch_interval_in_seconds end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
123 124 125 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 123 def @defined_tags end |
#display_name ⇒ String
[Required] Unique name that can be edited. The name should not contain any confidential information.
41 42 43 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 41 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
117 118 119 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 117 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the monitor.
37 38 39 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 37 def id @id end |
#is_run_now ⇒ BOOLEAN
[Required] If isRunNow is enabled, then the monitor will run immediately.
127 128 129 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 127 def is_run_now @is_run_now end |
#is_run_once ⇒ BOOLEAN
[Required] If runOnce is enabled, then the monitor will run once.
77 78 79 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 77 def is_run_once @is_run_once end |
#maintenance_window_schedule ⇒ OCI::ApmSynthetics::Models::MaintenanceWindowSchedule
97 98 99 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 97 def maintenance_window_schedule @maintenance_window_schedule end |
#monitor_type ⇒ String
[Required] The type of monitor.
45 46 47 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 45 def monitor_type @monitor_type end |
#repeat_interval_in_seconds ⇒ Integer
[Required] Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
73 74 75 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 73 def repeat_interval_in_seconds @repeat_interval_in_seconds end |
#scheduling_policy ⇒ String
[Required] Scheduling policy to decide the distribution of monitor executions on vantage points.
131 132 133 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 131 def scheduling_policy @scheduling_policy end |
#script_id ⇒ String
[Required] The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
59 60 61 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 59 def script_id @script_id end |
#script_name ⇒ String
[Required] Name of the script.
63 64 65 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 63 def script_name @script_name end |
#status ⇒ String
[Required] Enables or disables the monitor.
67 68 69 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 67 def status @status end |
#target ⇒ String
Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80
94 95 96 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 94 def target @target end |
#time_created ⇒ DateTime
The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
104 105 106 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 104 def time_created @time_created end |
#time_updated ⇒ DateTime
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
111 112 113 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 111 def time_updated @time_updated end |
#timeout_in_seconds ⇒ Integer
[Required] Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
85 86 87 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 85 def timeout_in_seconds @timeout_in_seconds end |
#vantage_point_count ⇒ Integer
[Required] Number of vantage points where monitor is running.
53 54 55 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 53 def vantage_point_count @vantage_point_count end |
#vantage_points ⇒ Array<OCI::ApmSynthetics::Models::VantagePointInfo>
[Required] List of public and dedicated vantage points where the monitor is running.
49 50 51 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 49 def vantage_points @vantage_points end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 138 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'monitor_type': :'monitorType', 'vantage_points': :'vantagePoints', 'vantage_point_count': :'vantagePointCount', 'script_id': :'scriptId', 'script_name': :'scriptName', 'status': :'status', 'repeat_interval_in_seconds': :'repeatIntervalInSeconds', 'is_run_once': :'isRunOnce', 'timeout_in_seconds': :'timeoutInSeconds', 'target': :'target', 'maintenance_window_schedule': :'maintenanceWindowSchedule', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'is_run_now': :'isRunNow', 'scheduling_policy': :'schedulingPolicy', 'batch_interval_in_seconds': :'batchIntervalInSeconds' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 166 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'monitor_type': :'String', 'vantage_points': :'Array<OCI::ApmSynthetics::Models::VantagePointInfo>', 'vantage_point_count': :'Integer', 'script_id': :'String', 'script_name': :'String', 'status': :'String', 'repeat_interval_in_seconds': :'Integer', 'is_run_once': :'BOOLEAN', 'timeout_in_seconds': :'Integer', 'target': :'String', 'maintenance_window_schedule': :'OCI::ApmSynthetics::Models::MaintenanceWindowSchedule', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'is_run_now': :'BOOLEAN', 'scheduling_policy': :'String', 'batch_interval_in_seconds': :'Integer' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 384 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && monitor_type == other.monitor_type && vantage_points == other.vantage_points && vantage_point_count == other.vantage_point_count && script_id == other.script_id && script_name == other.script_name && status == other.status && repeat_interval_in_seconds == other.repeat_interval_in_seconds && is_run_once == other.is_run_once && timeout_in_seconds == other.timeout_in_seconds && target == other.target && maintenance_window_schedule == other.maintenance_window_schedule && time_created == other.time_created && time_updated == other.time_updated && == other. && == other. && is_run_now == other.is_run_now && scheduling_policy == other.scheduling_policy && batch_interval_in_seconds == other.batch_interval_in_seconds end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 433 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
413 414 415 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 413 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
422 423 424 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 422 def hash [id, display_name, monitor_type, vantage_points, vantage_point_count, script_id, script_name, status, repeat_interval_in_seconds, is_run_once, timeout_in_seconds, target, maintenance_window_schedule, time_created, time_updated, , , is_run_now, scheduling_policy, batch_interval_in_seconds].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
466 467 468 469 470 471 472 473 474 475 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 466 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
460 461 462 |
# File 'lib/oci/apm_synthetics/models/monitor_summary.rb', line 460 def to_s to_hash.to_s end |