com.netflix.conductor.common.metadata.tasks

Class TaskDef

java.lang.Object

com.netflix.conductor.common.metadata.Auditable

com.netflix.conductor.common.metadata.tasks.TaskDef

@TaskTimeoutConstraint
 @Valid
public class TaskDef
extends Auditable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TaskDef.RetryLogic
static class	TaskDef.TimeoutPolicy

Constructor Summary

Constructors

Constructor and Description
TaskDef()
TaskDef(java.lang.String name)
TaskDef(java.lang.String name, java.lang.String description)
TaskDef(java.lang.String name, java.lang.String description, int retryCount, long timeoutSeconds)
TaskDef(java.lang.String name, java.lang.String description, java.lang.String ownerEmail, int retryCount, long timeoutSeconds, long responseTimeoutSeconds)

Method Summary

Modifier and Type	Method and Description
int	concurrencyLimit()
boolean	equals(java.lang.Object o)
java.lang.Integer	getConcurrentExecLimit()
java.lang.String	getDescription()
java.lang.String	getExecutionNameSpace()
java.util.List<java.lang.String>	getInputKeys()
java.util.Map<java.lang.String,java.lang.Object>	getInputTemplate()
java.lang.String	getIsolationGroupId()
java.lang.String	getName()
java.util.List<java.lang.String>	getOutputKeys()
java.lang.String	getOwnerEmail()
java.lang.Integer	getPollTimeoutSeconds()
java.lang.Integer	getRateLimitFrequencyInSeconds()
java.lang.Integer	getRateLimitPerFrequency()
long	getResponseTimeoutSeconds()
int	getRetryCount()
int	getRetryDelaySeconds()
TaskDef.RetryLogic	getRetryLogic()
TaskDef.TimeoutPolicy	getTimeoutPolicy()
long	getTimeoutSeconds()
int	hashCode()
void	setConcurrentExecLimit(java.lang.Integer concurrentExecLimit)
void	setDescription(java.lang.String description)
void	setExecutionNameSpace(java.lang.String executionNameSpace)
void	setInputKeys(java.util.List<java.lang.String> inputKeys)
void	setInputTemplate(java.util.Map<java.lang.String,java.lang.Object> inputTemplate)
void	setIsolationGroupId(java.lang.String isolationGroupId)
void	setName(java.lang.String name)
void	setOutputKeys(java.util.List<java.lang.String> outputKeys)
void	setOwnerEmail(java.lang.String ownerEmail)
void	setPollTimeoutSeconds(java.lang.Integer pollTimeoutSeconds)
void	setRateLimitFrequencyInSeconds(java.lang.Integer rateLimitFrequencyInSeconds)
void	setRateLimitPerFrequency(java.lang.Integer rateLimitPerFrequency)
void	setResponseTimeoutSeconds(long responseTimeoutSeconds)
void	setRetryCount(int retryCount)
void	setRetryDelaySeconds(int retryDelaySeconds)
void	setRetryLogic(TaskDef.RetryLogic retryLogic)
void	setTimeoutPolicy(TaskDef.TimeoutPolicy timeoutPolicy)
void	setTimeoutSeconds(long timeoutSeconds)
java.lang.String	toString()

Methods inherited from class com.netflix.conductor.common.metadata.Auditable

getCreatedBy, getCreateTime, getOwnerApp, getUpdatedBy, getUpdateTime, setCreatedBy, setCreateTime, setOwnerApp, setUpdatedBy, setUpdateTime

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskDef

public TaskDef()

TaskDef

public TaskDef(java.lang.String name)

TaskDef

public TaskDef(java.lang.String name,
               java.lang.String description)

TaskDef

public TaskDef(java.lang.String name,
               java.lang.String description,
               int retryCount,
               long timeoutSeconds)

TaskDef

public TaskDef(java.lang.String name,
               java.lang.String description,
               java.lang.String ownerEmail,
               int retryCount,
               long timeoutSeconds,
               long responseTimeoutSeconds)

Method Detail

getName

public java.lang.String getName()

Returns:

the name

setName

public void setName(java.lang.String name)

Parameters:

name - the name to set

getDescription

public java.lang.String getDescription()

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description to set

getRetryCount

public int getRetryCount()

Returns:

the retryCount

setRetryCount

public void setRetryCount(int retryCount)

Parameters:

retryCount - the retryCount to set

getTimeoutSeconds

public long getTimeoutSeconds()

Returns:

the timeoutSeconds

setTimeoutSeconds

public void setTimeoutSeconds(long timeoutSeconds)

Parameters:

timeoutSeconds - the timeoutSeconds to set

getInputKeys

public java.util.List<java.lang.String> getInputKeys()

Returns:

Returns the input keys

setInputKeys

public void setInputKeys(java.util.List<java.lang.String> inputKeys)

Parameters:

inputKeys - Set of keys that the task accepts in the input map

getOutputKeys

public java.util.List<java.lang.String> getOutputKeys()

Returns:

Returns the output keys for the task when executed

setOutputKeys

public void setOutputKeys(java.util.List<java.lang.String> outputKeys)

Parameters:

outputKeys - Sets the output keys

getTimeoutPolicy

public TaskDef.TimeoutPolicy getTimeoutPolicy()

Returns:

the timeoutPolicy

setTimeoutPolicy

public void setTimeoutPolicy(TaskDef.TimeoutPolicy timeoutPolicy)

Parameters:

timeoutPolicy - the timeoutPolicy to set

getRetryLogic

public TaskDef.RetryLogic getRetryLogic()

Returns:

the retryLogic

setRetryLogic

public void setRetryLogic(TaskDef.RetryLogic retryLogic)

Parameters:

retryLogic - the retryLogic to set

getRetryDelaySeconds

public int getRetryDelaySeconds()

Returns:

the retryDelaySeconds

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

setRetryDelaySeconds

public void setRetryDelaySeconds(int retryDelaySeconds)

Parameters:

retryDelaySeconds - the retryDelaySeconds to set

getInputTemplate

public java.util.Map<java.lang.String,java.lang.Object> getInputTemplate()

Returns:

the inputTemplate

getRateLimitPerFrequency

public java.lang.Integer getRateLimitPerFrequency()

Returns:

rateLimitPerFrequency The max number of tasks that will be allowed to be executed per rateLimitFrequencyInSeconds.

setRateLimitPerFrequency

public void setRateLimitPerFrequency(java.lang.Integer rateLimitPerFrequency)

Parameters:

rateLimitPerFrequency - The max number of tasks that will be allowed to be executed per rateLimitFrequencyInSeconds. Setting the value to 0 removes the rate limit

getRateLimitFrequencyInSeconds

public java.lang.Integer getRateLimitFrequencyInSeconds()

Returns:

rateLimitFrequencyInSeconds: The time bucket that is used to rate limit tasks based on getRateLimitPerFrequency() If null or not set, then defaults to 1 second

setRateLimitFrequencyInSeconds

public void setRateLimitFrequencyInSeconds(java.lang.Integer rateLimitFrequencyInSeconds)

Parameters:

rateLimitFrequencyInSeconds: - The time window/bucket for which the rate limit needs to be applied. This will only have affect if getRateLimitPerFrequency() is greater than zero

setConcurrentExecLimit

public void setConcurrentExecLimit(java.lang.Integer concurrentExecLimit)

Parameters:

concurrentExecLimit - Limit of number of concurrent task that can be IN_PROGRESS at a given time. Seting the value to 0 removes the limit.

getConcurrentExecLimit

public java.lang.Integer getConcurrentExecLimit()

Returns:

Limit of number of concurrent task that can be IN_PROGRESS at a given time

concurrencyLimit

public int concurrencyLimit()

Returns:

concurrency limit

setInputTemplate

public void setInputTemplate(java.util.Map<java.lang.String,java.lang.Object> inputTemplate)

Parameters:

inputTemplate - the inputTemplate to set

getIsolationGroupId

public java.lang.String getIsolationGroupId()

setIsolationGroupId

public void setIsolationGroupId(java.lang.String isolationGroupId)

getExecutionNameSpace

public java.lang.String getExecutionNameSpace()

setExecutionNameSpace

public void setExecutionNameSpace(java.lang.String executionNameSpace)

getOwnerEmail

public java.lang.String getOwnerEmail()

Returns:

the email of the owner of this task definition

setOwnerEmail

public void setOwnerEmail(java.lang.String ownerEmail)

Parameters:

ownerEmail - the owner email to set

setPollTimeoutSeconds

public void setPollTimeoutSeconds(java.lang.Integer pollTimeoutSeconds)

Parameters:

pollTimeoutSeconds - the poll timeout to set

getPollTimeoutSeconds

public java.lang.Integer getPollTimeoutSeconds()

Returns:

the poll timeout of this task definition

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