Task (The Java InfluxDB 2.x Client 6.2.0 API)

java.lang.Object
- com.influxdb.client.domain.Task

```
public class Task
extends Object
```
Task

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Task.LastRunStatusEnum
Gets or Sets lastRunStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`Task.LastRunStatusEnum` Gets or Sets lastRunStatus

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SERIALIZED_NAME_AUTHORIZATION_I_D`
`static String`	`SERIALIZED_NAME_CREATED_AT`
`static String`	`SERIALIZED_NAME_CRON`
`static String`	`SERIALIZED_NAME_DESCRIPTION`
`static String`	`SERIALIZED_NAME_EVERY`
`static String`	`SERIALIZED_NAME_FLUX`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_LABELS`
`static String`	`SERIALIZED_NAME_LAST_RUN_ERROR`
`static String`	`SERIALIZED_NAME_LAST_RUN_STATUS`
`static String`	`SERIALIZED_NAME_LATEST_COMPLETED`
`static String`	`SERIALIZED_NAME_LINKS`
`static String`	`SERIALIZED_NAME_NAME`
`static String`	`SERIALIZED_NAME_OFFSET`
`static String`	`SERIALIZED_NAME_ORG`
`static String`	`SERIALIZED_NAME_ORG_I_D`
`static String`	`SERIALIZED_NAME_OWNER_I_D`
`static String`	`SERIALIZED_NAME_STATUS`
`static String`	`SERIALIZED_NAME_TYPE`
`static String`	`SERIALIZED_NAME_UPDATED_AT`

Constructor Summary

Constructors
Constructor and Description

Task()

Constructors
Constructor and Description
`Task()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Task`	`addLabelsItem(Label labelsItem)`
`Task`	`authorizationID(String authorizationID)`
`Task`	`cron(String cron)`
`Task`	`description(String description)`
`boolean`	`equals(Object o)`
`Task`	`every(String every)`
`Task`	`flux(String flux)`
`String`	`getAuthorizationID()` ID of the authorization used when the task communicates with the query engine.
`OffsetDateTime`	`getCreatedAt()` Get createdAt
`String`	`getCron()` [Cron expression](https://en.wikipedia.org/wiki/Cron#Overview) that defines the schedule on which the task runs.
`String`	`getDescription()` Description of the task.
`String`	`getEvery()` Interval at which the task runs.
`String`	`getFlux()` Flux script to run for this task.
`String`	`getId()` Get id
`List<Label>`	`getLabels()` Get labels
`String`	`getLastRunError()` Get lastRunError
`Task.LastRunStatusEnum`	`getLastRunStatus()` Get lastRunStatus
`OffsetDateTime`	`getLatestCompleted()` Timestamp of the latest scheduled and completed run.
`TaskLinks`	`getLinks()` Get links
`String`	`getName()` Name of the task.
`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.
`String`	`getOrg()` Name of the organization that owns the task.
`String`	`getOrgID()` ID of the organization that owns the task.
`String`	`getOwnerID()` ID of the user who owns this Task.
`TaskStatusType`	`getStatus()` Get status
`String`	`getType()` Type of the task, useful for filtering a task list.
`OffsetDateTime`	`getUpdatedAt()` Get updatedAt
`int`	`hashCode()`
`Task`	`labels(List<Label> labels)`
`Task`	`links(TaskLinks links)`
`Task`	`name(String name)`
`Task`	`offset(String offset)`
`Task`	`org(String org)`
`Task`	`orgID(String orgID)`
`Task`	`ownerID(String ownerID)`
`void`	`setAuthorizationID(String authorizationID)`
`void`	`setCron(String cron)`
`void`	`setDescription(String description)`
`void`	`setEvery(String every)`
`void`	`setFlux(String flux)`
`void`	`setLabels(List<Label> labels)`
`void`	`setLinks(TaskLinks links)`
`void`	`setName(String name)`
`void`	`setOffset(String offset)`
`void`	`setOrg(String org)`
`void`	`setOrgID(String orgID)`
`void`	`setOwnerID(String ownerID)`
`void`	`setStatus(TaskStatusType status)`
`void`	`setType(String type)`
`Task`	`status(TaskStatusType status)`
`String`	`toString()`
`Task`	`type(String type)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TYPE
```
public static final String SERIALIZED_NAME_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ORG_I_D
```
public static final String SERIALIZED_NAME_ORG_I_D
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ORG
```
public static final String SERIALIZED_NAME_ORG
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_NAME
```
public static final String SERIALIZED_NAME_NAME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_OWNER_I_D
```
public static final String SERIALIZED_NAME_OWNER_I_D
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DESCRIPTION
```
public static final String SERIALIZED_NAME_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATUS
```
public static final String SERIALIZED_NAME_STATUS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LABELS
```
public static final String SERIALIZED_NAME_LABELS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_AUTHORIZATION_I_D
```
public static final String SERIALIZED_NAME_AUTHORIZATION_I_D
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FLUX
```
public static final String SERIALIZED_NAME_FLUX
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EVERY
```
public static final String SERIALIZED_NAME_EVERY
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CRON
```
public static final String SERIALIZED_NAME_CRON
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_OFFSET
```
public static final String SERIALIZED_NAME_OFFSET
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LATEST_COMPLETED
```
public static final String SERIALIZED_NAME_LATEST_COMPLETED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LAST_RUN_STATUS
```
public static final String SERIALIZED_NAME_LAST_RUN_STATUS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LAST_RUN_ERROR
```
public static final String SERIALIZED_NAME_LAST_RUN_ERROR
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CREATED_AT
```
public static final String SERIALIZED_NAME_CREATED_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_UPDATED_AT
```
public static final String SERIALIZED_NAME_UPDATED_AT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_LINKS
```
public static final String SERIALIZED_NAME_LINKS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Task
```
public Task()
```
- Method Detail
  - 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

Class Task

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ID

SERIALIZED_NAME_TYPE

SERIALIZED_NAME_ORG_I_D

SERIALIZED_NAME_ORG

SERIALIZED_NAME_NAME

SERIALIZED_NAME_OWNER_I_D

SERIALIZED_NAME_DESCRIPTION

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_LABELS

SERIALIZED_NAME_AUTHORIZATION_I_D

SERIALIZED_NAME_FLUX

SERIALIZED_NAME_EVERY

SERIALIZED_NAME_CRON

SERIALIZED_NAME_OFFSET

SERIALIZED_NAME_LATEST_COMPLETED

SERIALIZED_NAME_LAST_RUN_STATUS

SERIALIZED_NAME_LAST_RUN_ERROR

SERIALIZED_NAME_CREATED_AT

SERIALIZED_NAME_UPDATED_AT

SERIALIZED_NAME_LINKS

Constructor Detail

Task

Method Detail

getId

type

getType

setType

orgID

getOrgID

setOrgID

org

getOrg

setOrg

name

getName

setName

ownerID

getOwnerID

setOwnerID

description

getDescription

setDescription

status

getStatus

setStatus

labels

addLabelsItem

getLabels

setLabels

authorizationID

getAuthorizationID

setAuthorizationID

flux

getFlux

setFlux

every

getEvery

setEvery

cron

getCron

setCron

offset

getOffset

setOffset

getLatestCompleted

getLastRunStatus

getLastRunError

getCreatedAt

getUpdatedAt

links

getLinks

setLinks

equals