Class CreatePingMonitorDetails

The request body used to create a Ping monitor.

Inheritance

object

CreatePingMonitorDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.HealthchecksService.Models

Assembly: OCI.DotNetSDK.Healthchecks.dll

Syntax

public class CreatePingMonitorDetails

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The OCID of the compartment.

Remarks

Required

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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

DisplayName

Declaration

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

Property Value

Type	Description
string	A user-friendly and mutable name suitable for display in a user interface.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

IntervalInSeconds

Declaration

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

Property Value

Type	Description
int?	The monitor interval in seconds. Valid values: 10, 30, and 60.

Remarks

Required

IsEnabled

Declaration

[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }

Property Value

Type	Description
bool?	Enables or disables the monitor. Set to 'true' to launch monitoring.

Port

Declaration

[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }

Property Value

Type	Description
int?	The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

Protocol

Declaration

[Required(ErrorMessage = "Protocol is required.")]
[JsonProperty(PropertyName = "protocol")]
[JsonConverter(typeof(StringEnumConverter))]
public PingProbeProtocol? Protocol { get; set; }

Property Value

Type	Description
PingProbeProtocol?

Remarks

Required

Targets

Declaration

[Required(ErrorMessage = "Targets is required.")]
[JsonProperty(PropertyName = "targets")]
public List<string> Targets { get; set; }

Property Value

Type	Description
List<string>	A list of targets (hostnames or IP addresses) of the probe.

Remarks

Required

TimeoutInSeconds

Declaration

[JsonProperty(PropertyName = "timeoutInSeconds")]
public int? TimeoutInSeconds { get; set; }

Property Value

Type	Description
int?	The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.

VantagePointNames

Declaration

[JsonProperty(PropertyName = "vantagePointNames")]
public List<string> VantagePointNames { get; set; }

Property Value

Type	Description
List<string>	A list of names of vantage points from which to execute the probe.