Class TaskType

TaskType

Inheritance

System.Object

TaskType

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class TaskType : IEquatable<TaskType>

Constructors

TaskType()

Initializes a new instance of the TaskType class.

Declaration

protected TaskType()

TaskType(String, String, String, String, String, String, Nullable<TaskStatusType>, List<Label>, String, String, String, String, String, TaskLinks)

Initializes a new instance of the TaskType class.

Declaration

public TaskType(string type = null, string orgID = null, string org = null, string name = null, string ownerID = null, string description = null, TaskStatusType? status = null, List<Label> labels = null, string authorizationID = null, string flux = null, string every = null, string cron = null, string offset = null, TaskLinks links = null)

Parameters

Type	Name	Description
System.String	type	Type of the task, useful for filtering a task list..
System.String	orgID	ID of the organization that owns the task. (required).
System.String	org	Name of the organization that owns the task..
System.String	name	Name of the task. (required).
System.String	ownerID	ID of the user who owns this Task..
System.String	description	Description of the task..
System.Nullable<TaskStatusType>	status	status.
List<Label>	labels	labels.
System.String	authorizationID	ID of the authorization used when the task communicates with the query engine..
System.String	flux	Flux script to run for this task. (required).
System.String	every	Interval at which the task runs. every also determines when the task first runs, depending on the specified time. Value is a duration literal)..
System.String	cron	Cron expression that defines the schedule on which the task runs. Cron scheduling is based on system time. Value is a Cron expression..
System.String	offset	Duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset. The value is a duration literal..
TaskLinks	links	links.

Properties

AuthorizationID

ID of the authorization used when the task communicates with the query engine.

Declaration

public string AuthorizationID { get; set; }

Property Value

Type	Description
System.String	ID of the authorization used when the task communicates with the query engine.

CreatedAt

Gets or Sets CreatedAt

Declaration

public DateTime? CreatedAt { get; }

Property Value

Type	Description
System.Nullable<DateTime>

Cron

Cron expression that defines the schedule on which the task runs. Cron scheduling is based on system time. Value is a Cron expression.

Declaration

public string Cron { get; set; }

Property Value

Type	Description
System.String	Cron expression that defines the schedule on which the task runs. Cron scheduling is based on system time. Value is a Cron expression.

Description

Description of the task.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	Description of the task.

Every

Interval at which the task runs. every also determines when the task first runs, depending on the specified time. Value is a duration literal).

Declaration

public string Every { get; set; }

Property Value

Type	Description
System.String	Interval at which the task runs. every also determines when the task first runs, depending on the specified time. Value is a duration literal).

Flux

Flux script to run for this task.

Declaration

public string Flux { get; set; }

Property Value

Type	Description
System.String	Flux script to run for this task.

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 TaskType.LastRunStatusEnum? LastRunStatus { get; set; }

Property Value

Type	Description
System.Nullable<TaskType.LastRunStatusEnum>

LatestCompleted

Timestamp of the latest scheduled and completed run. Value is a timestamp in RFC3339 date/time format.

Declaration

public DateTime? LatestCompleted { get; }

Property Value

Type	Description
System.Nullable<DateTime>	Timestamp of the latest scheduled and completed run. Value is a timestamp in RFC3339 date/time format.

Links

Gets or Sets Links

Declaration

public TaskLinks Links { get; set; }

Property Value

Type	Description
TaskLinks

Name

Name of the task.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	Name of the task.

Offset

Duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset. The value is a duration literal.

Declaration

public string Offset { get; set; }

Property Value

Type	Description
System.String	Duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset. The value is a duration literal.

Org

Name of the organization that owns the task.

Declaration

public string Org { get; set; }

Property Value

Type	Description
System.String	Name of the organization that owns the task.

OrgID

ID of the organization that owns the task.

Declaration

public string OrgID { get; set; }

Property Value

Type	Description
System.String	ID of the organization that owns the task.

OwnerID

ID of the user who owns this Task.

Declaration

public string OwnerID { get; set; }

Property Value

Type	Description
System.String	ID of the user who owns this Task.

Status

Gets or Sets Status

Declaration

public TaskStatusType? Status { get; set; }

Property Value

Type	Description
System.Nullable<TaskStatusType>

Type

Type of the task, useful for filtering a task list.

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String	Type of the task, useful for filtering a task list.

UpdatedAt

Gets or Sets UpdatedAt

Declaration

public DateTime? UpdatedAt { get; }

Property Value

Type	Description
System.Nullable<DateTime>

Methods

Equals(TaskType)

Returns true if TaskType instances are equal

Declaration

public bool Equals(TaskType input)

Parameters

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