influxdb-client-js

InfluxDB 2.0 JavaScript client

View the Project on GitHub influxdata/influxdb-client-js

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

TasksAPI class

Tasks API

Signature:

declare class TasksAPI 

Constructors

Constructor Modifiers Description
(constructor)(influxDB)   Creates TasksAPI

Methods

Method Modifiers Description
deleteTasksID(request, requestOptions)   Delete a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteTasksID
deleteTasksIDLabelsID(request, requestOptions)   Delete a label from a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteTasksIDLabelsID
deleteTasksIDMembersID(request, requestOptions)   Remove a member from a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteTasksIDMembersID
deleteTasksIDOwnersID(request, requestOptions)   Remove an owner from a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteTasksIDOwnersID
deleteTasksIDRunsID(request, requestOptions)   Cancel a running task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteTasksIDRunsID
getTasks(request, requestOptions)   List tasks. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasks
getTasksID(request, requestOptions)   Retrieve a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasksID
getTasksIDLabels(request, requestOptions)   List labels for a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasksIDLabels
getTasksIDLogs(request, requestOptions)   Retrieve all logs for a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasksIDLogs
getTasksIDMembers(request, requestOptions)   List all task members. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasksIDMembers
getTasksIDOwners(request, requestOptions)   List all owners of a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasksIDOwners
getTasksIDRuns(request, requestOptions)   List runs for a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasksIDRuns
getTasksIDRunsID(request, requestOptions)   Retrieve a run for a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasksIDRunsID
getTasksIDRunsIDLogs(request, requestOptions)   Retrieve all logs for a run. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetTasksIDRunsIDLogs
patchTasksID(request, requestOptions)   Update a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchTasksID
postTasks(request, requestOptions)   Create a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostTasks
postTasksIDLabels(request, requestOptions)   Add a label to a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostTasksIDLabels
postTasksIDMembers(request, requestOptions)   Add a member to a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostTasksIDMembers
postTasksIDOwners(request, requestOptions)   Add an owner for a task. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostTasksIDOwners
postTasksIDRuns(request, requestOptions)   Start a task run, overriding the schedule. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostTasksIDRuns
postTasksIDRunsIDRetry(request, requestOptions)   Retry a task run. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostTasksIDRunsIDRetry