Home > @influxdata/influxdb-client-apis > Task

Task interface

Signature:

interface Task 

Properties

Property	Modifiers	Type	Description
authorizationID?		string	<p>(Optional) An authorization ID. Specifies the authorization used when the task communicates with the query engine.</p><p>To find an authorization ID, you can use the to list authorizations.</p>
createdAt?	readonly	string	(Optional)
cron?		string	(Optional) A Cron expression that defines the schedule on which the task runs. InfluxDB uses the system time when evaluating Cron expressions.
description?		string	(Optional) A description of the task.
every?		string	(Optional) The interval (duration literal) at which the task runs. every also determines when the task first runs, depending on the specified time.
flux		string	The Flux script that the task executes.
id	readonly	string
labels?		Labels	(Optional)
lastRunError?	readonly	string	(Optional)
lastRunStatus?	readonly	‘failed’ | ‘success’ | ‘canceled’	(Optional)
latestCompleted?	readonly	string	(Optional) A timestamp (RFC3339 date/time format) of the latest scheduled and completed run.
links?	readonly	{ self?: Link; owners?: Link; members?: Link; runs?: Link; logs?: Link; labels?: Link; }	(Optional)
name		string	The name of the task.
offset?		string	(Optional) A duration to delay execution of the task after the scheduled time has elapsed. 0 removes the offset.
org?		string	(Optional) An organization name. Specifies the organization that owns the task.
orgID		string	An organization ID. Specifies the organization that owns the task.
ownerID?		string	<p>(Optional) A user ID. Specifies the owner of the task.</p><p>To find a user ID, you can use the to list users.</p>
status?		TaskStatusType	(Optional)
updatedAt?	readonly	string	(Optional)