Class Monitor

The information about a monitor.

Inheritance

object

Monitor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApmsyntheticsService.Models

Assembly: OCI.DotNetSDK.Apmsynthetics.dll

Syntax

public class Monitor

Properties

AvailabilityConfiguration

Declaration

[JsonProperty(PropertyName = "availabilityConfiguration")]
public AvailabilityConfiguration AvailabilityConfiguration { get; set; }

Property Value

Type	Description
AvailabilityConfiguration

BatchIntervalInSeconds

Declaration

[Required(ErrorMessage = "BatchIntervalInSeconds is required.")]
[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).

Remarks

Required

Configuration

Declaration

[JsonProperty(PropertyName = "configuration")]
public MonitorConfiguration Configuration { get; set; }

Property Value

Type	Description
MonitorConfiguration

ContentType

Declaration

[JsonProperty(PropertyName = "contentType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ContentTypes? ContentType { get; set; }

Property Value

Type	Description
ContentTypes?	Content type of the script.

CreatedBy

Declaration

[JsonProperty(PropertyName = "createdBy")]
public string CreatedBy { get; set; }

Property Value

Type	Description
string	Name of the user that created the monitor.

DefinedTags

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

[Required(ErrorMessage = "DisplayName is required.")]
[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.

Remarks

Required

FreeformTags

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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the monitor.

Remarks

Required

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

[Required(ErrorMessage = "IsRunNow is required.")]
[JsonProperty(PropertyName = "isRunNow")]
public bool? IsRunNow { get; set; }

Property Value

Type	Description
bool?	If isRunNow is enabled, then the monitor will run immediately.

Remarks

Required

IsRunOnce

Declaration

[Required(ErrorMessage = "IsRunOnce is required.")]
[JsonProperty(PropertyName = "isRunOnce")]
public bool? IsRunOnce { get; set; }

Property Value

Type	Description
bool?	If runOnce is enabled, then the monitor will run once.

Remarks

Required

LastUpdatedBy

Declaration

[JsonProperty(PropertyName = "lastUpdatedBy")]
public string LastUpdatedBy { get; set; }

Property Value

Type	Description
string	Name of the user that recently updated the monitor.

MaintenanceWindowSchedule

Declaration

[JsonProperty(PropertyName = "maintenanceWindowSchedule")]
public MaintenanceWindowSchedule MaintenanceWindowSchedule { get; set; }

Property Value

Type	Description
MaintenanceWindowSchedule

MonitorType

Declaration

[Required(ErrorMessage = "MonitorType is required.")]
[JsonProperty(PropertyName = "monitorType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MonitorTypes? MonitorType { get; set; }

Property Value

Type	Description
MonitorTypes?	Type of monitor.

Remarks

Required

RepeatIntervalInSeconds

Declaration

[Required(ErrorMessage = "RepeatIntervalInSeconds is required.")]
[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.

Remarks

Required

SchedulingPolicy

Declaration

[Required(ErrorMessage = "SchedulingPolicy is required.")]
[JsonProperty(PropertyName = "schedulingPolicy")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SchedulingPolicy? SchedulingPolicy { get; set; }

Property Value

Type	Description
SchedulingPolicy?	Scheduling policy to decide the distribution of monitor executions on vantage points.

Remarks

Required

ScriptId

Declaration

[Required(ErrorMessage = "ScriptId is required.")]
[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.

Remarks

Required

ScriptName

Declaration

[Required(ErrorMessage = "ScriptName is required.")]
[JsonProperty(PropertyName = "scriptName")]
public string ScriptName { get; set; }

Property Value

Type	Description
string	Name of the script.

Remarks

Required

ScriptParameters

Declaration

[JsonProperty(PropertyName = "scriptParameters")]
public List<MonitorScriptParameterInfo> ScriptParameters { get; set; }

Property Value

Type	Description
List<MonitorScriptParameterInfo>	List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]

Status

Declaration

[Required(ErrorMessage = "Status is required.")]
[JsonProperty(PropertyName = "status")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MonitorStatus? Status { get; set; }

Property Value

Type	Description
MonitorStatus?	Enables or disables the monitor.

Remarks

Required

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.

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.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

TimeoutInSeconds

Declaration

[Required(ErrorMessage = "TimeoutInSeconds is required.")]
[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.

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.

Remarks

Required

VantagePointCount

Declaration

[Required(ErrorMessage = "VantagePointCount is required.")]
[JsonProperty(PropertyName = "vantagePointCount")]
public int? VantagePointCount { get; set; }

Property Value

Type	Description
int?	Number of vantage points where monitor is running.

Remarks

Required

VantagePoints

Declaration

[Required(ErrorMessage = "VantagePoints is required.")]
[JsonProperty(PropertyName = "vantagePoints")]
public List<VantagePointInfo> VantagePoints { get; set; }

Property Value

Type	Description
List<VantagePointInfo>	List of public, dedicated and onPremise vantage points where the monitor is running.

Remarks

Required