Class DeadmanCheck
DeadmanCheck
Inherited Members
Namespace: InfluxDB.Client.Api.Domain
Assembly: InfluxDB.Client.dll
Syntax
public class DeadmanCheck : Check, IEquatable<CheckDiscriminator>, IEquatable<Check>, IEquatable<DeadmanCheck>
Constructors
DeadmanCheck()
Initializes a new instance of the DeadmanCheck class.
Declaration
protected DeadmanCheck()
DeadmanCheck(DeadmanCheck.TypeEnum, String, String, Nullable<Boolean>, Nullable<CheckStatusLevel>, String, String, List<ThresholdCheckTags>, String, String, String, String, DashboardQuery, Nullable<TaskStatusType>, String, List<Label>, CheckBaseLinks)
Initializes a new instance of the DeadmanCheck class.
Declaration
public DeadmanCheck(DeadmanCheck.TypeEnum type = default(DeadmanCheck.TypeEnum), string timeSince = null, string staleTime = null, bool? reportZero = null, CheckStatusLevel? level = null, string every = null, string offset = null, List<ThresholdCheckTags> tags = null, string statusMessageTemplate = null, string name = null, string orgID = null, string taskID = null, DashboardQuery query = null, TaskStatusType? status = null, string description = null, List<Label> labels = null, CheckBaseLinks links = null)
Parameters
Type | Name | Description |
---|---|---|
DeadmanCheck.TypeEnum | type | type (required) (default to TypeEnum.Deadman). |
System.String | timeSince | String duration before deadman triggers.. |
System.String | staleTime | String duration for time that a series is considered stale and should not trigger deadman.. |
System.Nullable<System.Boolean> | reportZero | If only zero values reported since time, trigger an alert. |
System.Nullable<CheckStatusLevel> | level | level. |
System.String | every | Check repetition interval.. |
System.String | offset | Duration to delay after the schedule, before executing check.. |
List<ThresholdCheckTags> | tags | List of tags to write to each status.. |
System.String | statusMessageTemplate | The template used to generate and write a status message.. |
System.String | name | |
System.String | orgID | |
System.String | taskID | |
DashboardQuery | query | |
System.Nullable<TaskStatusType> | status | |
System.String | description | |
List<Label> | labels | |
CheckBaseLinks | links |
Properties
Every
Check repetition interval.
Declaration
public string Every { get; set; }
Property Value
Type | Description |
---|---|
System.String | Check repetition interval. |
Level
Gets or Sets Level
Declaration
public CheckStatusLevel? Level { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<CheckStatusLevel> |
Offset
Duration to delay after the schedule, before executing check.
Declaration
public string Offset { get; set; }
Property Value
Type | Description |
---|---|
System.String | Duration to delay after the schedule, before executing check. |
ReportZero
If only zero values reported since time, trigger an alert
Declaration
public bool? ReportZero { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Boolean> | If only zero values reported since time, trigger an alert |
StaleTime
String duration for time that a series is considered stale and should not trigger deadman.
Declaration
public string StaleTime { get; set; }
Property Value
Type | Description |
---|---|
System.String | String duration for time that a series is considered stale and should not trigger deadman. |
StatusMessageTemplate
The template used to generate and write a status message.
Declaration
public string StatusMessageTemplate { get; set; }
Property Value
Type | Description |
---|---|
System.String | The template used to generate and write a status message. |
Tags
List of tags to write to each status.
Declaration
public List<ThresholdCheckTags> Tags { get; set; }
Property Value
Type | Description |
---|---|
List<ThresholdCheckTags> | List of tags to write to each status. |
TimeSince
String duration before deadman triggers.
Declaration
public string TimeSince { get; set; }
Property Value
Type | Description |
---|---|
System.String | String duration before deadman triggers. |
Type
Gets or Sets Type
Declaration
public DeadmanCheck.TypeEnum Type { get; set; }
Property Value
Type | Description |
---|---|
DeadmanCheck.TypeEnum |
Methods
Equals(DeadmanCheck)
Returns true if DeadmanCheck instances are equal
Declaration
public bool Equals(DeadmanCheck input)
Parameters
Type | Name | Description |
---|---|---|
DeadmanCheck | input | Instance of DeadmanCheck to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Equals(Object)
Returns true if objects are equal
Declaration
public override bool Equals(object input)
Parameters
Type | Name | Description |
---|---|---|
System.Object | input | Object to be compared |
Returns
Type | Description |
---|---|
System.Boolean | Boolean |
Overrides
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | Hash code |
Overrides
ToJson()
Returns the JSON string presentation of the object
Declaration
public override string ToJson()
Returns
Type | Description |
---|---|
System.String | JSON string presentation of the object |
Overrides
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String | String presentation of the object |