Class HttpProbe

A summary that contains all of the mutable and immutable properties for an HTTP probe.

Inheritance

object

HttpProbe

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 HttpProbe

Properties

CompartmentId

Declaration

[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment.

Headers

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	A dictionary of HTTP request headers. Note: Monitors and probes do not support the use of the `Authorization` HTTP header.

HomeRegion

Declaration

[JsonProperty(PropertyName = "homeRegion")]
public string HomeRegion { get; set; }

Property Value

Type	Description
string	The region where updates must be made and where results must be fetched from.

Id

Declaration

[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the resource.

Method

Declaration

[JsonProperty(PropertyName = "method")]
[JsonConverter(typeof(ResponseEnumConverter))]
public HttpProbeMethod? Method { get; set; }

Property Value

Type	Description
HttpProbeMethod?

Path

Declaration

[JsonProperty(PropertyName = "path")]
public string Path { get; set; }

Property Value

Type	Description
string	The optional URL path to probe, including query parameters.

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

[JsonProperty(PropertyName = "protocol")]
[JsonConverter(typeof(ResponseEnumConverter))]
public HttpProbeProtocol? Protocol { get; set; }

Property Value

Type	Description
HttpProbeProtocol?

ResultsUrl

Declaration

[JsonProperty(PropertyName = "resultsUrl")]
public string ResultsUrl { get; set; }

Property Value

Type	Description
string	A URL for fetching the probe results.

Targets

Declaration

[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.

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The RFC 3339-formatted creation date and time of the probe.

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.