org.apache.nifi.web.api.dto

Class ProcessorConfigDTO

java.lang.Object

org.apache.nifi.web.api.dto.ProcessorConfigDTO

public class ProcessorConfigDTO
extends java.lang.Object

Configuration details for a processor in this NiFi.

Constructor Summary

Constructors

Constructor and Description
ProcessorConfigDTO()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnnotationData() Annotation data for this processor.
java.util.Set<java.lang.String>	getAutoTerminatedRelationships()
java.lang.String	getBulletinLevel()
java.lang.String	getComments()
java.lang.Integer	getConcurrentlySchedulableTaskCount() The number of tasks that should be concurrently scheduled for this processor.
java.lang.String	getCustomUiUrl()
java.util.Map<java.lang.String,java.lang.String>	getDefaultConcurrentTasks()
java.util.Map<java.lang.String,java.lang.String>	getDefaultSchedulingPeriod()
java.util.Map<java.lang.String,PropertyDescriptorDTO>	getDescriptors()
java.lang.String	getExecutionNode() Indicates which node the process should run on
java.lang.String	getPenaltyDuration()
java.util.Map<java.lang.String,java.lang.String>	getProperties() The properties for this processor.
java.lang.Long	getRunDurationMillis()
java.lang.String	getSchedulingPeriod() The frequency with which to schedule the processor.
java.lang.String	getSchedulingStrategy() Indicates whether the processor should be scheduled to run in event-driven mode or timer-driven mode
java.lang.String	getYieldDuration()
java.lang.Boolean	isLossTolerant()
void	setAnnotationData(java.lang.String annotationData)
void	setAutoTerminatedRelationships(java.util.Set<java.lang.String> autoTerminatedRelationships)
void	setBulletinLevel(java.lang.String bulletinLevel)
void	setComments(java.lang.String comments)
void	setConcurrentlySchedulableTaskCount(java.lang.Integer concurrentlySchedulableTaskCount)
void	setCustomUiUrl(java.lang.String customUiUrl)
void	setDefaultConcurrentTasks(java.util.Map<java.lang.String,java.lang.String> defaultConcurrentTasks)
void	setDefaultSchedulingPeriod(java.util.Map<java.lang.String,java.lang.String> defaultSchedulingPeriod)
void	setDescriptors(java.util.Map<java.lang.String,PropertyDescriptorDTO> descriptors)
void	setExecutionNode(java.lang.String executionNode)
void	setLossTolerant(java.lang.Boolean lossTolerant)
void	setPenaltyDuration(java.lang.String penaltyDuration)
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
void	setRunDurationMillis(java.lang.Long runDurationMillis)
void	setSchedulingPeriod(java.lang.String setSchedulingPeriod)
void	setSchedulingStrategy(java.lang.String schedulingStrategy)
void	setYieldDuration(java.lang.String yieldDuration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessorConfigDTO

public ProcessorConfigDTO()

Method Detail

getSchedulingPeriod

public java.lang.String getSchedulingPeriod()

The frequency with which to schedule the processor. The format of the value will depend on the value of getSchedulingStrategy().

Returns:

The scheduling period

setSchedulingPeriod

public void setSchedulingPeriod(java.lang.String setSchedulingPeriod)

getSchedulingStrategy

public java.lang.String getSchedulingStrategy()

Indicates whether the processor should be scheduled to run in event-driven mode or timer-driven mode

Returns:

scheduling strategy

setSchedulingStrategy

public void setSchedulingStrategy(java.lang.String schedulingStrategy)

getExecutionNode

public java.lang.String getExecutionNode()

Indicates which node the process should run on

Returns:

execution node

setExecutionNode

public void setExecutionNode(java.lang.String executionNode)

getPenaltyDuration

public java.lang.String getPenaltyDuration()

Returns:

the amount of time that is used when this processor penalizes a flowfile

setPenaltyDuration

public void setPenaltyDuration(java.lang.String penaltyDuration)

getYieldDuration

public java.lang.String getYieldDuration()

Returns:

amount of time must elapse before this processor is scheduled again when yielding

setYieldDuration

public void setYieldDuration(java.lang.String yieldDuration)

getBulletinLevel

public java.lang.String getBulletinLevel()

Returns:

the level at this this processor will report bulletins

setBulletinLevel

public void setBulletinLevel(java.lang.String bulletinLevel)

getConcurrentlySchedulableTaskCount

public java.lang.Integer getConcurrentlySchedulableTaskCount()

The number of tasks that should be concurrently scheduled for this processor. If this processor doesn't allow parallel processing then any positive input will be ignored.

Returns:

the concurrently schedulable task count

setConcurrentlySchedulableTaskCount

public void setConcurrentlySchedulableTaskCount(java.lang.Integer concurrentlySchedulableTaskCount)

isLossTolerant

public java.lang.Boolean isLossTolerant()

Returns:

whether or not this Processor is Loss Tolerant

setLossTolerant

public void setLossTolerant(java.lang.Boolean lossTolerant)

getComments

public java.lang.String getComments()

Returns:

the comments

setComments

public void setComments(java.lang.String comments)

getProperties

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

The properties for this processor. Properties whose value is not set will only contain the property name. These properties are (un)marshalled differently since we need/want to control the ordering of the properties. The descriptors and metadata are used as a lookup when processing these properties.

Returns:

The optional properties

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

getDescriptors

public java.util.Map<java.lang.String,PropertyDescriptorDTO> getDescriptors()

Returns:

descriptors for this processor's properties

setDescriptors

public void setDescriptors(java.util.Map<java.lang.String,PropertyDescriptorDTO> descriptors)

getAnnotationData

public java.lang.String getAnnotationData()

Annotation data for this processor.

Returns:

The annotation data

setAnnotationData

public void setAnnotationData(java.lang.String annotationData)

getCustomUiUrl

public java.lang.String getCustomUiUrl()

Returns:

the URL for this processors custom configuration UI if applicable. Null otherwise.

setCustomUiUrl

public void setCustomUiUrl(java.lang.String customUiUrl)

getAutoTerminatedRelationships

public java.util.Set<java.lang.String> getAutoTerminatedRelationships()

Returns:

the names of all processor relationships that cause a flow file to be terminated if the relationship is not connected to anything

setAutoTerminatedRelationships

public void setAutoTerminatedRelationships(java.util.Set<java.lang.String> autoTerminatedRelationships)

getDefaultConcurrentTasks

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

Returns:

maps default values for concurrent tasks for each applicable scheduling strategy.

setDefaultConcurrentTasks

public void setDefaultConcurrentTasks(java.util.Map<java.lang.String,java.lang.String> defaultConcurrentTasks)

getRunDurationMillis

public java.lang.Long getRunDurationMillis()

Returns:

run duration in milliseconds

setRunDurationMillis

public void setRunDurationMillis(java.lang.Long runDurationMillis)

getDefaultSchedulingPeriod

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

Returns:

Maps default values for scheduling period for each applicable scheduling strategy

setDefaultSchedulingPeriod

public void setDefaultSchedulingPeriod(java.util.Map<java.lang.String,java.lang.String> defaultSchedulingPeriod)