Package com.influxdb.client.domain

Class Task

java.lang.Object
com.influxdb.client.domain.Task
public class Task extends Object
Task

  • Field Details

  • Constructor Details

    • Task

      public Task()

  • Method Details

    • getId

      public String getId()
      Get id
      Returns:
      id

    • type

      public Task type(String type)

    • getType

      public String getType()
      Type of the task, useful for filtering a task list.
      Returns:
      type

    • setType

      public void setType(String type)

    • orgID

      public Task orgID(String orgID)

    • getOrgID

      public String getOrgID()
      ID of the organization that owns the task.
      Returns:
      orgID

    • setOrgID

      public void setOrgID(String orgID)

    • org

      public Task org(String org)

    • getOrg

      public String getOrg()
      Name of the organization that owns the task.
      Returns:
      org

    • setOrg

      public void setOrg(String org)

    • name

      public Task name(String name)

    • getName

      public String getName()
      Name of the task.
      Returns:
      name

    • setName

      public void setName(String name)

    • ownerID

      public Task ownerID(String ownerID)

    • getOwnerID

      public String getOwnerID()
      ID of the user who owns this Task.
      Returns:
      ownerID

    • setOwnerID

      public void setOwnerID(String ownerID)

    • description

      public Task description(String description)

    • getDescription

      public String getDescription()
      Description of the task.
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • status

      public Task status(TaskStatusType status)

    • getStatus

      public TaskStatusType getStatus()
      Get status
      Returns:
      status

    • setStatus

      public void setStatus(TaskStatusType status)

    • labels

      public Task labels(List<Label> labels)

    • addLabelsItem

      public Task addLabelsItem(Label labelsItem)

    • getLabels

      public List<Label> getLabels()
      Get labels
      Returns:
      labels

    • setLabels

      public void setLabels(List<Label> labels)

    • authorizationID

      public Task authorizationID(String authorizationID)

    • getAuthorizationID

      public String getAuthorizationID()
      ID of the authorization used when the task communicates with the query engine.
      Returns:
      authorizationID

    • setAuthorizationID

      public void setAuthorizationID(String authorizationID)

    • flux

      public Task flux(String flux)

    • getFlux

      public String getFlux()
      Flux script to run for this task.
      Returns:
      flux

    • setFlux

      public void setFlux(String flux)

    • every

      public Task every(String every)

    • getEvery

      public String getEvery()
      Interval at which the task runs. `every` also determines when the task first runs, depending on the specified time. Value is a [duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals)).
      Returns:
      every

    • setEvery

      public void setEvery(String every)

    • cron

      public Task cron(String cron)

    • getCron

      public String getCron()
      [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs. Cron scheduling is based on system time. Value is a [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview).
      Returns:
      cron

    • setCron

      public void setCron(String cron)

    • offset

      public Task offset(String offset)

    • getOffset

      public String getOffset()
      [Duration](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals) to delay execution of the task after the scheduled time has elapsed. `0` removes the offset. The value is a [duration literal](https://docs.influxdata.com/flux/v0.x/spec/lexical-elements/#duration-literals).
      Returns:
      offset

    • setOffset

      public void setOffset(String offset)

    • getLatestCompleted

      public OffsetDateTime getLatestCompleted()
      Timestamp of the latest scheduled and completed run. Value is a timestamp in [RFC3339 date/time format](https://docs.influxdata.com/flux/v0.x/data-types/basic/time/#time-syntax).
      Returns:
      latestCompleted

    • getLastRunStatus

      public Task.LastRunStatusEnum getLastRunStatus()
      Get lastRunStatus
      Returns:
      lastRunStatus

    • getLastRunError

      public String getLastRunError()
      Get lastRunError
      Returns:
      lastRunError

    • getCreatedAt

      public OffsetDateTime getCreatedAt()
      Get createdAt
      Returns:
      createdAt

    • getUpdatedAt

      public OffsetDateTime getUpdatedAt()
      Get updatedAt
      Returns:
      updatedAt

    • links

      public Task links(TaskLinks links)

    • getLinks

      public TaskLinks getLinks()
      Get links
      Returns:
      links

    • setLinks

      public void setLinks(TaskLinks links)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object