Class CheckBase
CheckBase
Namespace: InfluxDB.Client.Api.Domain
Assembly: InfluxDB.Client.dll
Syntax
public class CheckBase : IEquatable<CheckBase>Constructors
CheckBase()
Initializes a new instance of the CheckBase class.
Declaration
protected CheckBase()CheckBase(String, String, String, DashboardQuery, Nullable<TaskStatusType>, String, List<Label>, CheckBaseLinks)
Initializes a new instance of the CheckBase class.
Declaration
public CheckBase(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 |
|---|---|---|
| System.String | name | name (required). |
| System.String | orgID | The ID of the organization that owns this check. (required). |
| System.String | taskID | The ID of the task associated with this check.. |
| DashboardQuery | query | query (required). |
| System.Nullable<TaskStatusType> | status | status. |
| System.String | description | An optional description of the check.. |
| List<Label> | labels | labels. |
| CheckBaseLinks | 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 check.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | An optional description of the check. |
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 CheckBase.LastRunStatusEnum? LastRunStatus { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<CheckBase.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. |
Links
Gets or Sets Links
Declaration
public CheckBaseLinks Links { get; set; }Property Value
| Type | Description |
|---|---|
| CheckBaseLinks |
Name
Gets or Sets Name
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
OrgID
The ID of the organization that owns this check.
Declaration
public string OrgID { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The ID of the organization that owns this check. |
OwnerID
The ID of creator used to create this check.
Declaration
public string OwnerID { get; }Property Value
| Type | Description |
|---|---|
| System.String | The ID of creator used to create this check. |
Query
Gets or Sets Query
Declaration
public DashboardQuery Query { get; set; }Property Value
| Type | Description |
|---|---|
| DashboardQuery |
Status
Gets or Sets Status
Declaration
public TaskStatusType? Status { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<TaskStatusType> |
TaskID
The ID of the task associated with this check.
Declaration
public string TaskID { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The ID of the task associated with this check. |
UpdatedAt
Gets or Sets UpdatedAt
Declaration
public DateTime? UpdatedAt { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<DateTime> |
Methods
Equals(CheckBase)
Returns true if CheckBase instances are equal
Declaration
public bool Equals(CheckBase input)Parameters
| Type | Name | Description |
|---|---|---|
| CheckBase | input | Instance of CheckBase 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 |