Class NotificationRuleBase

NotificationRuleBase

Inheritance

NotificationRuleBase

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class NotificationRuleBase : IEquatable<NotificationRuleBase>

Constructors

NotificationRuleBase()

Initializes a new instance of the NotificationRuleBase class.

Declaration

protected NotificationRuleBase()

NotificationRuleBase(String, String, String, TaskStatusType, String, String, String, String, String, Nullable<Int32>, Nullable<Int32>, List<TagRule>, String, List<StatusRule>, List<Label>, NotificationRuleBaseLinks)

Initializes a new instance of the NotificationRuleBase class.

Declaration

public NotificationRuleBase(string endpointID = null, string orgID = null, string taskID = null, TaskStatusType status = default(TaskStatusType), string name = null, string sleepUntil = null, string every = null, string offset = null, string runbookLink = null, int? limitEvery = null, int? limit = null, List<TagRule> tagRules = null, string description = null, List<StatusRule> statusRules = null, List<Label> labels = null, NotificationRuleBaseLinks links = null)

Parameters

Type	Name	Description
System.String	endpointID	endpointID (required).
System.String	orgID	The ID of the organization that owns this notification rule. (required).
System.String	taskID	The ID of the task associated with this notification rule..
TaskStatusType	status	status (required).
System.String	name	Human-readable name describing the notification rule. (required).
System.String	sleepUntil	sleepUntil.
System.String	every	The notification repetition interval..
System.String	offset	Duration to delay after the schedule, before executing check..
System.String	runbookLink	runbookLink.
System.Nullable<System.Int32>	limitEvery	Don't notify me more than <limit> times every <limitEvery> seconds. If set, limit cannot be empty..
System.Nullable<System.Int32>	limit	Don't notify me more than <limit> times every <limitEvery> seconds. If set, limitEvery cannot be empty..
List<TagRule>	tagRules	List of tag rules the notification rule attempts to match..
System.String	description	An optional description of the notification rule..
List<StatusRule>	statusRules	List of status rules the notification rule attempts to match. (required).
List<Label>	labels	labels.
NotificationRuleBaseLinks	links	links.

Properties

CreatedAt

Gets or Sets CreatedAt

Declaration

public DateTime? CreatedAt { get; }

Property Value

Type	Description
System.Nullable<DateTime>

Description

An optional description of the notification rule.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	An optional description of the notification rule.

EndpointID

Gets or Sets EndpointID

Declaration

public string EndpointID { get; set; }

Property Value

Type	Description
System.String

Every

The notification repetition interval.

Declaration

public string Every { get; set; }

Property Value

Type	Description
System.String	The notification repetition interval.

Id

Gets or Sets Id

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

Labels

Gets or Sets Labels

Declaration

public List<Label> Labels { get; set; }

Property Value

Type	Description
List<Label>

LastRunError

Gets or Sets LastRunError

Declaration

public string LastRunError { get; }

Property Value

Type	Description
System.String

LastRunStatus

Gets or Sets LastRunStatus

Declaration

public NotificationRuleBase.LastRunStatusEnum? LastRunStatus { get; set; }

Property Value

Type	Description
System.Nullable<NotificationRuleBase.LastRunStatusEnum>

LatestCompleted

Timestamp (in RFC3339 date/time format](https://datatracker.ietf.org/doc/html/rfc3339)) of the latest scheduled and completed run.

Declaration

public DateTime? LatestCompleted { get; }

Property Value

Type	Description
System.Nullable<DateTime>	Timestamp (in RFC3339 date/time format](https://datatracker.ietf.org/doc/html/rfc3339)) of the latest scheduled and completed run.

Limit

Don't notify me more than <limit> times every <limitEvery> seconds. If set, limitEvery cannot be empty.

Declaration

public int? Limit { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	Don't notify me more than <limit> times every <limitEvery> seconds. If set, limitEvery cannot be empty.

LimitEvery

Don't notify me more than <limit> times every <limitEvery> seconds. If set, limit cannot be empty.

Declaration

public int? LimitEvery { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	Don't notify me more than <limit> times every <limitEvery> seconds. If set, limit cannot be empty.

Links

Gets or Sets Links

Declaration

public NotificationRuleBaseLinks Links { get; set; }

Property Value

Type	Description
NotificationRuleBaseLinks

Name

Human-readable name describing the notification rule.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	Human-readable name describing the notification rule.

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.

OrgID

The ID of the organization that owns this notification rule.

Declaration

public string OrgID { get; set; }

Property Value

Type	Description
System.String	The ID of the organization that owns this notification rule.

OwnerID

The ID of creator used to create this notification rule.

Declaration

public string OwnerID { get; }

Property Value

Type	Description
System.String	The ID of creator used to create this notification rule.

RunbookLink

Gets or Sets RunbookLink

Declaration

public string RunbookLink { get; set; }

Property Value

Type	Description
System.String

SleepUntil

Gets or Sets SleepUntil

Declaration

public string SleepUntil { get; set; }

Property Value

Type	Description
System.String

Status

Gets or Sets Status

Declaration

public TaskStatusType Status { get; set; }

Property Value

Type	Description
TaskStatusType

StatusRules

List of status rules the notification rule attempts to match.

Declaration

public List<StatusRule> StatusRules { get; set; }

Property Value

Type	Description
List<StatusRule>	List of status rules the notification rule attempts to match.

TagRules

List of tag rules the notification rule attempts to match.

Declaration

public List<TagRule> TagRules { get; set; }

Property Value

Type	Description
List<TagRule>	List of tag rules the notification rule attempts to match.

TaskID

The ID of the task associated with this notification rule.

Declaration

public string TaskID { get; set; }

Property Value

Type	Description
System.String	The ID of the task associated with this notification rule.

UpdatedAt

Gets or Sets UpdatedAt

Declaration

public DateTime? UpdatedAt { get; }

Property Value

Type	Description
System.Nullable<DateTime>

Methods

Equals(NotificationRuleBase)

Returns true if NotificationRuleBase instances are equal

Declaration

public bool Equals(NotificationRuleBase input)

Parameters

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

GetHashCode()

Gets the hash code

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	Hash code

ToJson()

Returns the JSON string presentation of the object

Declaration

public virtual string ToJson()

Returns

Type	Description
System.String	JSON string presentation of the object

ToString()

Returns the string presentation of the object

Declaration

public override string ToString()

Returns

Type	Description
System.String	String presentation of the object