Task (conductor-common 2.7.0 API)

java.lang.Object
- com.netflix.conductor.common.metadata.tasks.Task

public class Task
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Task.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`Task.Status`

Constructor Summary

Constructors
Constructor and Description

Task()

Constructors
Constructor and Description
`Task()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Task`	`copy()`
`boolean`	`equals(java.lang.Object o)`
`long`	`getCallbackAfterSeconds()`
`java.lang.String`	`getCorrelationId()`
`java.lang.String`	`getDomain()`
`long`	`getEndTime()`
`java.lang.String`	`getExternalInputPayloadStoragePath()`
`java.lang.String`	`getExternalOutputPayloadStoragePath()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getInputData()`
`com.google.protobuf.Any`	`getInputMessage()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getOutputData()`
`com.google.protobuf.Any`	`getOutputMessage()`
`int`	`getPollCount()`
`long`	`getQueueWaitTime()`
`int`	`getRateLimitFrequencyInSeconds()`
`int`	`getRateLimitPerFrequency()`
`java.lang.String`	`getReasonForIncompletion()`
`java.lang.String`	`getReferenceTaskName()`
`long`	`getResponseTimeoutSeconds()`
`java.lang.String`	`getRetriedTaskId()`
`int`	`getRetryCount()`
`long`	`getScheduledTime()`
`int`	`getSeq()`
`int`	`getStartDelayInSeconds()`
`long`	`getStartTime()`
`Task.Status`	`getStatus()`
`java.util.Optional<TaskDef>`	`getTaskDefinition()`
`java.lang.String`	`getTaskDefName()`
`java.lang.String`	`getTaskId()`
`Task.Status`	`getTaskStatus()` Deprecated.
`java.lang.String`	`getTaskType()`
`long`	`getUpdateTime()`
`java.lang.String`	`getWorkerId()`
`java.lang.String`	`getWorkflowInstanceId()`
`WorkflowTask`	`getWorkflowTask()`
`java.lang.String`	`getWorkflowType()`
`int`	`hashCode()`
`boolean`	`isCallbackFromWorker()`
`boolean`	`isExecuted()`
`boolean`	`isRetried()`
`void`	`setCallbackAfterSeconds(long callbackAfterSeconds)`
`void`	`setCallbackFromWorker(boolean callbackFromWorker)`
`void`	`setCorrelationId(java.lang.String correlationId)`
`void`	`setDomain(java.lang.String domain)`
`void`	`setEndTime(long endTime)`
`void`	`setExecuted(boolean executed)`
`void`	`setExternalInputPayloadStoragePath(java.lang.String externalInputPayloadStoragePath)`
`void`	`setExternalOutputPayloadStoragePath(java.lang.String externalOutputPayloadStoragePath)`
`void`	`setInputData(java.util.Map<java.lang.String,java.lang.Object> inputData)`
`void`	`setInputMessage(com.google.protobuf.Any inputMessage)`
`void`	`setOutputData(java.util.Map<java.lang.String,java.lang.Object> outputData)`
`void`	`setOutputMessage(com.google.protobuf.Any outputMessage)`
`void`	`setPollCount(int pollCount)`
`void`	`setQueueWaitTime(long t)`
`void`	`setRateLimitFrequencyInSeconds(int rateLimitFrequencyInSeconds)`
`void`	`setRateLimitPerFrequency(int rateLimitPerFrequency)`
`void`	`setReasonForIncompletion(java.lang.String reasonForIncompletion)`
`void`	`setReferenceTaskName(java.lang.String referenceTaskName)`
`void`	`setResponseTimeoutSeconds(long responseTimeoutSeconds)`
`void`	`setRetried(boolean retried)`
`void`	`setRetriedTaskId(java.lang.String retriedTaskId)`
`void`	`setRetryCount(int retryCount)`
`void`	`setScheduledTime(long scheduledTime)`
`void`	`setSeq(int seq)`
`void`	`setStartDelayInSeconds(int startDelayInSeconds)`
`void`	`setStartTime(long startTime)`
`void`	`setStatus(Task.Status status)`
`void`	`setTaskDefName(java.lang.String taskDefName)`
`void`	`setTaskId(java.lang.String taskId)`
`void`	`setTaskStatus(Task.Status taskStatus)` Deprecated.
`void`	`setTaskType(java.lang.String taskType)`
`void`	`setUpdateTime(long updateTime)`
`void`	`setWorkerId(java.lang.String workerId)`
`void`	`setWorkflowInstanceId(java.lang.String workflowInstanceId)`
`void`	`setWorkflowTask(WorkflowTask workflowTask)`
`Task`	`setWorkflowType(java.lang.String workflowType)`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - Task
```
public Task()
```
- Method Detail
  - getTaskType
```
public java.lang.String getTaskType()
```
    Returns:
    
    Type of the task
    
    See Also:
    
    TaskType
  - setTaskType
```
public void setTaskType(java.lang.String taskType)
```
  - getStatus
```
public Task.Status getStatus()
```
    Returns:
    
    Status of the task
  - setStatus
```
public void setStatus(Task.Status status)
```
    Parameters:
    
    status - Status of the task
  - getTaskStatus
```
@Deprecated
public Task.Status getTaskStatus()
```
    Deprecated.
  - setTaskStatus
```
@Deprecated
public void setTaskStatus(Task.Status taskStatus)
```
    Deprecated.
  - getInputData
```
public java.util.Map<java.lang.String,java.lang.Object> getInputData()
```
  - setInputData
```
public void setInputData(java.util.Map<java.lang.String,java.lang.Object> inputData)
```
  - getReferenceTaskName
```
public java.lang.String getReferenceTaskName()
```
    Returns:
    
    the referenceTaskName
  - setReferenceTaskName
```
public void setReferenceTaskName(java.lang.String referenceTaskName)
```
    Parameters:
    
    referenceTaskName - the referenceTaskName to set
  - getCorrelationId
```
public java.lang.String getCorrelationId()
```
    Returns:
    
    the correlationId
  - setCorrelationId
```
public void setCorrelationId(java.lang.String correlationId)
```
    Parameters:
    
    correlationId - the correlationId to set
  - getRetryCount
```
public int getRetryCount()
```
    Returns:
    
    the retryCount
  - setRetryCount
```
public void setRetryCount(int retryCount)
```
    Parameters:
    
    retryCount - the retryCount to set
  - getScheduledTime
```
public long getScheduledTime()
```
    Returns:
    
    the scheduledTime
  - setScheduledTime
```
public void setScheduledTime(long scheduledTime)
```
    Parameters:
    
    scheduledTime - the scheduledTime to set
  - getStartTime
```
public long getStartTime()
```
    Returns:
    
    the startTime
  - setStartTime
```
public void setStartTime(long startTime)
```
    Parameters:
    
    startTime - the startTime to set
  - getEndTime
```
public long getEndTime()
```
    Returns:
    
    the endTime
  - setEndTime
```
public void setEndTime(long endTime)
```
    Parameters:
    
    endTime - the endTime to set
  - getStartDelayInSeconds
```
public int getStartDelayInSeconds()
```
    Returns:
    
    the startDelayInSeconds
  - setStartDelayInSeconds
```
public void setStartDelayInSeconds(int startDelayInSeconds)
```
    Parameters:
    
    startDelayInSeconds - the startDelayInSeconds to set
  - getRetriedTaskId
```
public java.lang.String getRetriedTaskId()
```
    Returns:
    
    the retriedTaskId
  - setRetriedTaskId
```
public void setRetriedTaskId(java.lang.String retriedTaskId)
```
    Parameters:
    
    retriedTaskId - the retriedTaskId to set
  - getSeq
```
public int getSeq()
```
    Returns:
    
    the seq
  - setSeq
```
public void setSeq(int seq)
```
    Parameters:
    
    seq - the seq to set
  - getUpdateTime
```
public long getUpdateTime()
```
    Returns:
    
    the updateTime
  - setUpdateTime
```
public void setUpdateTime(long updateTime)
```
    Parameters:
    
    updateTime - the updateTime to set
  - getQueueWaitTime
```
public long getQueueWaitTime()
```
    Returns:
    
    the queueWaitTime
  - setQueueWaitTime
```
public void setQueueWaitTime(long t)
```
  - isRetried
```
public boolean isRetried()
```
    Returns:
    
    True if the task has been retried after failure
  - setRetried
```
public void setRetried(boolean retried)
```
    Parameters:
    
    retried - the retried to set
  - isExecuted
```
public boolean isExecuted()
```
    Returns:
    
    True if the task has completed its lifecycle within conductor (from start to completion to being updated in the datastore)
  - setExecuted
```
public void setExecuted(boolean executed)
```
    Parameters:
    
    executed - the executed value to set
  - getPollCount
```
public int getPollCount()
```
    Returns:
    
    No. of times task has been polled
  - setPollCount
```
public void setPollCount(int pollCount)
```
  - isCallbackFromWorker
```
public boolean isCallbackFromWorker()
```
  - setCallbackFromWorker
```
public void setCallbackFromWorker(boolean callbackFromWorker)
```
  - getTaskDefName
```
public java.lang.String getTaskDefName()
```
    Returns:
    
    Name of the task definition
  - setTaskDefName
```
public void setTaskDefName(java.lang.String taskDefName)
```
    Parameters:
    
    taskDefName - Name of the task definition
  - getResponseTimeoutSeconds
```
public long getResponseTimeoutSeconds()
```
    Returns:
    
    the timeout for task to send response. After this timeout, the task will be re-queued
  - setResponseTimeoutSeconds
```
public void setResponseTimeoutSeconds(long responseTimeoutSeconds)
```
    Parameters:
    
    responseTimeoutSeconds - - timeout for task to send response. After this timeout, the task will be re-queued
  - getWorkflowInstanceId
```
public java.lang.String getWorkflowInstanceId()
```
    Returns:
    
    the workflowInstanceId
  - setWorkflowInstanceId
```
public void setWorkflowInstanceId(java.lang.String workflowInstanceId)
```
    Parameters:
    
    workflowInstanceId - the workflowInstanceId to set
  - getWorkflowType
```
public java.lang.String getWorkflowType()
```
  - setWorkflowType
```
public Task setWorkflowType(java.lang.String workflowType)
```
    Parameters:
    
    workflowType - the name of the workflow
    
    Returns:
    
    the task object with the workflow type set
  - getTaskId
```
public java.lang.String getTaskId()
```
    Returns:
    
    the taskId
  - setTaskId
```
public void setTaskId(java.lang.String taskId)
```
    Parameters:
    
    taskId - the taskId to set
  - getReasonForIncompletion
```
public java.lang.String getReasonForIncompletion()
```
    Returns:
    
    the reasonForIncompletion
  - setReasonForIncompletion
```
public void setReasonForIncompletion(java.lang.String reasonForIncompletion)
```
    Parameters:
    
    reasonForIncompletion - the reasonForIncompletion to set
  - getCallbackAfterSeconds
```
public long getCallbackAfterSeconds()
```
    Returns:
    
    the callbackAfterSeconds
  - setCallbackAfterSeconds
```
public void setCallbackAfterSeconds(long callbackAfterSeconds)
```
    Parameters:
    
    callbackAfterSeconds - the callbackAfterSeconds to set
  - getWorkerId
```
public java.lang.String getWorkerId()
```
    Returns:
    
    the workerId
  - setWorkerId
```
public void setWorkerId(java.lang.String workerId)
```
    Parameters:
    
    workerId - the workerId to set
  - getOutputData
```
public java.util.Map<java.lang.String,java.lang.Object> getOutputData()
```
    Returns:
    
    the outputData
  - setOutputData
```
public void setOutputData(java.util.Map<java.lang.String,java.lang.Object> outputData)
```
    Parameters:
    
    outputData - the outputData to set
  - getWorkflowTask
```
public WorkflowTask getWorkflowTask()
```
    Returns:
    
    Workflow Task definition
  - setWorkflowTask
```
public void setWorkflowTask(WorkflowTask workflowTask)
```
    Parameters:
    
    workflowTask - Task definition
  - getDomain
```
public java.lang.String getDomain()
```
    Returns:
    
    the domain
  - setDomain
```
public void setDomain(java.lang.String domain)
```
    Parameters:
    
    domain - the Domain
  - getInputMessage
```
public com.google.protobuf.Any getInputMessage()
```
  - setInputMessage
```
public void setInputMessage(com.google.protobuf.Any inputMessage)
```
  - setRateLimitPerFrequency
```
public void setRateLimitPerFrequency(int rateLimitPerFrequency)
```
  - getOutputMessage
```
public com.google.protobuf.Any getOutputMessage()
```
  - setOutputMessage
```
public void setOutputMessage(com.google.protobuf.Any outputMessage)
```
  - getTaskDefinition
```
public java.util.Optional<TaskDef> getTaskDefinition()
```
    Returns:
    
    Optional containing the task definition if available
  - getRateLimitPerFrequency
```
public int getRateLimitPerFrequency()
```
  - getRateLimitFrequencyInSeconds
```
public int getRateLimitFrequencyInSeconds()
```
  - setRateLimitFrequencyInSeconds
```
public void setRateLimitFrequencyInSeconds(int rateLimitFrequencyInSeconds)
```
  - getExternalInputPayloadStoragePath
```
public java.lang.String getExternalInputPayloadStoragePath()
```
    Returns:
    
    the external storage path for the task input payload
  - setExternalInputPayloadStoragePath
```
public void setExternalInputPayloadStoragePath(java.lang.String externalInputPayloadStoragePath)
```
    Parameters:
    
    externalInputPayloadStoragePath - the external storage path where the task input payload is stored
  - getExternalOutputPayloadStoragePath
```
public java.lang.String getExternalOutputPayloadStoragePath()
```
    Returns:
    
    the external storage path for the task output payload
  - setExternalOutputPayloadStoragePath
```
public void setExternalOutputPayloadStoragePath(java.lang.String externalOutputPayloadStoragePath)
```
    Parameters:
    
    externalOutputPayloadStoragePath - the external storage path where the task output payload is stored
  - copy
```
public Task copy()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Task

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Task

Method Detail

getTaskType

setTaskType

getStatus

setStatus

getTaskStatus

setTaskStatus

getInputData

setInputData

getReferenceTaskName

setReferenceTaskName

getCorrelationId

setCorrelationId

getRetryCount

setRetryCount

getScheduledTime

setScheduledTime

getStartTime

setStartTime

getEndTime

setEndTime

getStartDelayInSeconds

setStartDelayInSeconds

getRetriedTaskId

setRetriedTaskId

getSeq

setSeq

getUpdateTime

setUpdateTime

getQueueWaitTime

setQueueWaitTime

isRetried

setRetried

isExecuted

setExecuted

getPollCount

setPollCount

isCallbackFromWorker

setCallbackFromWorker

getTaskDefName

setTaskDefName

getResponseTimeoutSeconds

setResponseTimeoutSeconds

getWorkflowInstanceId

setWorkflowInstanceId

getWorkflowType

setWorkflowType

getTaskId

setTaskId

getReasonForIncompletion

setReasonForIncompletion

getCallbackAfterSeconds

setCallbackAfterSeconds

getWorkerId

setWorkerId

getOutputData

setOutputData

getWorkflowTask

setWorkflowTask

getDomain

setDomain

getInputMessage

setInputMessage

setRateLimitPerFrequency

getOutputMessage

setOutputMessage

getTaskDefinition

getRateLimitPerFrequency

getRateLimitFrequencyInSeconds

setRateLimitFrequencyInSeconds

getExternalInputPayloadStoragePath

setExternalInputPayloadStoragePath

getExternalOutputPayloadStoragePath