Class: OCI::ApmSynthetics::Models::Monitor

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_synthetics/models/monitor.rb

Overview

The information about a 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_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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Monitor

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
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
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 195

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.script_parameters = attributes[:'scriptParameters'] if attributes[:'scriptParameters']

  raise 'You cannot provide both :scriptParameters and :script_parameters' if attributes.key?(:'scriptParameters') && attributes.key?(:'script_parameters')

  self.script_parameters = attributes[:'script_parameters'] if attributes[:'script_parameters']

  self.configuration = attributes[:'configuration'] if attributes[:'configuration']

  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.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
end

Instance Attribute Details

#configuration ⇒ OCI::ApmSynthetics::Models::MonitorConfiguration

Returns:



91
92
93
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 91

def configuration
  @configuration
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


117
118
119
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 117

def defined_tags
  @defined_tags
end

#display_name ⇒ String

**[Required]** Unique name that can be edited. The name should not contain any confidential information.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 32

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: `"value"`

Returns:

  • (Hash<String, String>) 


111
112
113
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 111

def freeform_tags
  @freeform_tags
end

#id ⇒ String

**[Required]** The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the monitor.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 28

def id
  @id
end

#is_run_once ⇒ BOOLEAN

**[Required]** If runOnce is enabled, then the monitor will run once.

Returns:

  • (BOOLEAN) 


68
69
70
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 68

def is_run_once
  @is_run_once
end

#monitor_type ⇒ String

**[Required]** Type of the monitor.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 36

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.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 64

def repeat_interval_in_seconds
  @repeat_interval_in_seconds
end

#script_id ⇒ String

**[Required]** The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) 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.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 50

def script_id
  @script_id
end

#script_name ⇒ String

**[Required]** Name of the script.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 54

def script_name
  @script_name
end

#script_parameters ⇒ Array<OCI::ApmSynthetics::Models::MonitorScriptParameterInfo>

List of script parameters. Example: `[{"paramName": "userid", "paramValue":"testuser", "isSecret": false, "isOverwritten": false}]`

Returns:



88
89
90
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 88

def script_parameters
  @script_parameters
end

#status ⇒ String

**[Required]** Enables or disables the monitor.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 58

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.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 83

def target
  @target
end

#time_created ⇒ DateTime

The time the resource was created, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`

Returns:

  • (DateTime) 


98
99
100
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 98

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the resource was updated, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z`

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 105

def time_updated
  @time_updated
end

#timeout_in_seconds ⇒ Integer

**[Required]** Timeout in seconds. Timeout cannot be more than 30% 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.

Returns:

  • (Integer) 


75
76
77
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 75

def timeout_in_seconds
  @timeout_in_seconds
end

#vantage_point_count ⇒ Integer

**[Required]** Number of vantage points where monitor is running.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 44

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.

Returns:



40
41
42
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 40

def vantage_points
  @vantage_points
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 120

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',
    'script_parameters': :'scriptParameters',
    'configuration': :'configuration',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 146

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',
    'script_parameters': :'Array<OCI::ApmSynthetics::Models::MonitorScriptParameterInfo>',
    'configuration': :'OCI::ApmSynthetics::Models::MonitorConfiguration',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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.

Parameters:

  • other (Object) —

    the other object to be compared



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 329

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 &&
    script_parameters == other.script_parameters &&
    configuration == other.configuration &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 376

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


356
357
358
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 356

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



365
366
367
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 365

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, script_parameters, configuration, time_created, time_updated, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



409
410
411
412
413
414
415
416
417
418
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 409

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

Returns:

  • (String) —

    String presentation of the object



403
404
405
 
# File 'lib/oci/apm_synthetics/models/monitor.rb', line 403

def to_s
  to_hash.to_s
end