Class UpdateMonitorDetails
Details of the request body used to update a monitor.
Inheritance
UpdateMonitorDetails
Assembly: OCI.DotNetSDK.Apmsynthetics.dll
Syntax
public class UpdateMonitorDetails
Properties
AvailabilityConfiguration
Declaration
[JsonProperty(PropertyName = "availabilityConfiguration")]
public AvailabilityConfiguration AvailabilityConfiguration { get; set; }
Property Value
BatchIntervalInSeconds
Declaration
[JsonProperty(PropertyName = "batchIntervalInSeconds")]
public int? BatchIntervalInSeconds { get; set; }
Property Value
| Type |
Description |
| int? |
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
|
Configuration
Declaration
[JsonProperty(PropertyName = "configuration")]
public MonitorConfiguration Configuration { get; set; }
Property Value
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
| Type |
Description |
| Dictionary<string, Dictionary<string, object>> |
Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: {"foo-namespace": {"bar-key": "value"}}
|
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
| Type |
Description |
| string |
Unique name that can be edited. The name should not contain any confidential information.
|
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
| Type |
Description |
| Dictionary<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"}
|
IsIPv6
Declaration
[JsonProperty(PropertyName = "isIPv6")]
public bool? IsIPv6 { get; set; }
Property Value
| Type |
Description |
| bool? |
If enabled, domain name will resolve to an IPv6 address.
|
IsRunNow
Declaration
[JsonProperty(PropertyName = "isRunNow")]
public bool? IsRunNow { get; set; }
Property Value
| Type |
Description |
| bool? |
If isRunNow is enabled, then the monitor will run immediately.
|
IsRunOnce
Declaration
[JsonProperty(PropertyName = "isRunOnce")]
public bool? IsRunOnce { get; set; }
Property Value
| Type |
Description |
| bool? |
If runOnce is enabled, then the monitor will run once.
|
MaintenanceWindowSchedule
Declaration
[JsonProperty(PropertyName = "maintenanceWindowSchedule")]
public MaintenanceWindowSchedule MaintenanceWindowSchedule { get; set; }
Property Value
RepeatIntervalInSeconds
Declaration
[JsonProperty(PropertyName = "repeatIntervalInSeconds")]
public int? RepeatIntervalInSeconds { get; set; }
Property Value
| Type |
Description |
| int? |
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.
|
SchedulingPolicy
Declaration
[JsonProperty(PropertyName = "schedulingPolicy")]
[JsonConverter(typeof(StringEnumConverter))]
public SchedulingPolicy? SchedulingPolicy { get; set; }
Property Value
| Type |
Description |
| SchedulingPolicy? |
Scheduling policy to decide the distribution of monitor executions on vantage points.
|
ScriptId
Declaration
[JsonProperty(PropertyName = "scriptId")]
public string ScriptId { get; set; }
Property Value
| Type |
Description |
| 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.
|
ScriptParameters
Declaration
[JsonProperty(PropertyName = "scriptParameters")]
public List<MonitorScriptParameter> ScriptParameters { get; set; }
Property Value
| Type |
Description |
| List<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"}]
|
Status
Declaration
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(StringEnumConverter))]
public MonitorStatus? Status { get; set; }
Property Value
Target
Declaration
[JsonProperty(PropertyName = "target")]
public string Target { get; set; }
Property Value
| Type |
Description |
| string |
Specify the endpoint on which to run the monitor.
For BROWSER, REST, NETWORK, DNS and FTP 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.
|
TimeoutInSeconds
Declaration
[JsonProperty(PropertyName = "timeoutInSeconds")]
public int? TimeoutInSeconds { get; set; }
Property Value
| Type |
Description |
| int? |
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.
|
VantagePoints
Declaration
[JsonProperty(PropertyName = "vantagePoints")]
public List<string> VantagePoints { get; set; }
Property Value
| Type |
Description |
| List<string> |
A list of public and dedicated vantage points from which to execute the monitor.
Use /publicVantagePoints to fetch public vantage points, and /dedicatedVantagePoints to fetch dedicated vantage points.
|