Class ThresholdCheck

ThresholdCheck

Inheritance

System.Object

CheckBase

CheckDiscriminator

Check

ThresholdCheck

Implements

IEquatable<CheckDiscriminator>

IEquatable<Check>

IEquatable<ThresholdCheck>

Inherited Members

Check.Equals(Check)

CheckDiscriminator.Equals(CheckDiscriminator)

CheckBase.Status

CheckBase.LastRunStatus

CheckBase.Id

CheckBase.Name

CheckBase.OrgID

CheckBase.TaskID

CheckBase.OwnerID

CheckBase.CreatedAt

CheckBase.UpdatedAt

CheckBase.Query

CheckBase.Description

CheckBase.LatestCompleted

CheckBase.LastRunError

CheckBase.Labels

CheckBase.Links

CheckBase.Equals(CheckBase)

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class ThresholdCheck : Check, IEquatable<CheckDiscriminator>, IEquatable<Check>, IEquatable<ThresholdCheck>

Constructors

ThresholdCheck()

Initializes a new instance of the ThresholdCheck class.

Declaration

protected ThresholdCheck()

ThresholdCheck(ThresholdCheck.TypeEnum, List<Threshold>, String, String, List<ThresholdCheckTags>, String, String, String, String, DashboardQuery, Nullable<TaskStatusType>, String, List<Label>, CheckBaseLinks)

Initializes a new instance of the ThresholdCheck class.

Declaration

public ThresholdCheck(ThresholdCheck.TypeEnum type = default(ThresholdCheck.TypeEnum), List<Threshold> thresholds = 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
ThresholdCheck.TypeEnum	type	type (required) (default to TypeEnum.Threshold).
List<Threshold>	thresholds	thresholds.
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.

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.

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.

Thresholds

Gets or Sets Thresholds

Declaration

public List<Threshold> Thresholds { get; set; }

Property Value

Type	Description
List<Threshold>

Type

Gets or Sets Type

Declaration

public ThresholdCheck.TypeEnum Type { get; set; }

Property Value

Type	Description
ThresholdCheck.TypeEnum

Methods

Equals(ThresholdCheck)

Returns true if ThresholdCheck instances are equal

Declaration

public bool Equals(ThresholdCheck input)

Parameters

Type	Name	Description
ThresholdCheck	input	Instance of ThresholdCheck 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

Check.Equals(Object)

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code

Overrides

Check.GetHashCode()

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

Check.ToJson()

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
System.String	String presentation of the object

Overrides

Check.ToString()

Implements

IEquatable<>

IEquatable<>

IEquatable<>