Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateMonitorDetails

Details of the request body used to update a monitor.

Properties

Optional configuration

Optional definedTags

definedTags: undefined | object

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

Optional displayName

displayName: undefined | 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: {\"bar-key\": \"value\"}

Optional repeatIntervalInSeconds

repeatIntervalInSeconds: undefined | number

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional scriptId

scriptId: undefined | 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.

Optional scriptParameters

scriptParameters: Array<MonitorScriptParameter>

List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{\"paramName\": \"userid\", \"paramValue\":\"testuser\"}]

Optional status

status: model.MonitorStatus

Enables or disables the monitor.

Optional target

target: undefined | 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.

Optional timeoutInSeconds

timeoutInSeconds: undefined | number

Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. 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.

Optional vantagePoints

vantagePoints: Array<string>

A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

Functions

getDeserializedJsonObj

getJsonObj