Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace MonitorSummary

Information about the monitor.

Properties

batchIntervalInSeconds

batchIntervalInSeconds: number

Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN). Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional configuration

Optional definedTags

definedTags: undefined | object

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

displayName

displayName: string

Unique name that can be edited. The name should not contain any confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the monitor.

isRunNow

isRunNow: boolean

If isRunNow is enabled, then the monitor will run immediately.

isRunOnce

isRunOnce: boolean

If runOnce is enabled, then the monitor will run once.

Optional maintenanceWindowSchedule

maintenanceWindowSchedule: model.MaintenanceWindowSchedule

monitorType

monitorType: MonitorTypes

The type of monitor.

repeatIntervalInSeconds

repeatIntervalInSeconds: number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

schedulingPolicy

schedulingPolicy: SchedulingPolicy

Scheduling policy to decide the distribution of monitor executions on vantage points.

scriptId

scriptId: string

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.

scriptName

scriptName: string

Name of the script.

status

Enables or disables the monitor.

Optional target

target: undefined | string

Specify the endpoint on which to run the monitor. For BROWSER, REST and NETWORK 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

Optional timeCreated

timeCreated: Date

The time the resource was created, expressed in RFC 3339 timestamp format. Example: {@code 2020-02-12T22:47:12.613Z}

Optional timeUpdated

timeUpdated: Date

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: {@code 2020-02-13T22:47:12.613Z}

timeoutInSeconds

timeoutInSeconds: number

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. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

vantagePointCount

vantagePointCount: number

Number of vantage points where monitor is running. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

vantagePoints

vantagePoints: Array<VantagePointInfo>

List of public and dedicated vantage points where the monitor is running.

Functions

getDeserializedJsonObj

getJsonObj