ProcessorConfigDTO (nifi-client-dto 1.23.2 API)

java.lang.Object
- org.apache.nifi.web.api.dto.ProcessorConfigDTO

```
public class ProcessorConfigDTO
extends Object
```
Configuration details for a processor in this NiFi.

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`annotationData`
`private Set<String>`	`autoTerminatedRelationships`
`private String`	`backoffMechanism`
`private String`	`bulletinLevel`
`private String`	`comments`
`private Integer`	`concurrentlySchedulableTaskCount`
`private String`	`customUiUrl`
`private Map<String,String>`	`defaultConcurrentTasks`
`private Map<String,String>`	`defaultSchedulingPeriod`
`private Map<String,PropertyDescriptorDTO>`	`descriptors`
`private String`	`executionNode`
`private Boolean`	`lossTolerant`
`private String`	`maxBackoffPeriod`
`private String`	`penaltyDuration`
`private Map<String,String>`	`properties`
`private Set<String>`	`retriedRelationships`
`private Integer`	`retryCount`
`private Long`	`runDurationMillis`
`private String`	`schedulingPeriod`
`private String`	`schedulingStrategy`
`private Set<String>`	`sensitiveDynamicPropertyNames`
`private String`	`yieldDuration`

Constructor Summary

Constructors
Constructor and Description

ProcessorConfigDTO()

Constructors
Constructor and Description
`ProcessorConfigDTO()`

Method Summary

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

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

Field Detail

properties
```
private Map<String,String> properties
```

descriptors

private Map<String,PropertyDescriptorDTO> descriptors

sensitiveDynamicPropertyNames

private Set<String> sensitiveDynamicPropertyNames

schedulingPeriod
```
private String schedulingPeriod
```

schedulingStrategy
```
private String schedulingStrategy
```

executionNode
```
private String executionNode
```

penaltyDuration
```
private String penaltyDuration
```

yieldDuration
```
private String yieldDuration
```

bulletinLevel
```
private String bulletinLevel
```

runDurationMillis
```
private Long runDurationMillis
```

concurrentlySchedulableTaskCount

private Integer concurrentlySchedulableTaskCount

autoTerminatedRelationships

private Set<String> autoTerminatedRelationships

comments
```
private String comments
```

customUiUrl
```
private String customUiUrl
```

lossTolerant
```
private Boolean lossTolerant
```

annotationData
```
private String annotationData
```

defaultConcurrentTasks

private Map<String,String> defaultConcurrentTasks

defaultSchedulingPeriod

private Map<String,String> defaultSchedulingPeriod

retryCount
```
private Integer retryCount
```

retriedRelationships

private Set<String> retriedRelationships

backoffMechanism
```
private String backoffMechanism
```

maxBackoffPeriod
```
private String maxBackoffPeriod
```

Constructor Detail
- ProcessorConfigDTO
```
public ProcessorConfigDTO()
```

Method Detail
- getSchedulingPeriod
```
public 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(String setSchedulingPeriod)
```
- getSchedulingStrategy
```
public 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(String schedulingStrategy)
```
- getExecutionNode
```
public String getExecutionNode()
```
  Indicates which node the process should run on
  
  Returns:
  
  execution node
- setExecutionNode
```
public void setExecutionNode(String executionNode)
```
- getPenaltyDuration
```
public String getPenaltyDuration()
```
  Returns:
  
  the amount of time that is used when this processor penalizes a flowfile
- setPenaltyDuration
```
public void setPenaltyDuration(String penaltyDuration)
```
- getYieldDuration
```
public String getYieldDuration()
```
  Returns:
  
  amount of time must elapse before this processor is scheduled again when yielding
- setYieldDuration
```
public void setYieldDuration(String yieldDuration)
```
- getBulletinLevel
```
public String getBulletinLevel()
```
  Returns:
  
  the level at this this processor will report bulletins
- setBulletinLevel
```
public void setBulletinLevel(String bulletinLevel)
```
- getConcurrentlySchedulableTaskCount
```
public 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(Integer concurrentlySchedulableTaskCount)
```
- isLossTolerant
```
public Boolean isLossTolerant()
```
  Returns:
  
  whether or not this Processor is Loss Tolerant
- setLossTolerant
```
public void setLossTolerant(Boolean lossTolerant)
```
- getComments
```
public String getComments()
```
  Returns:
  
  the comments
- setComments
```
public void setComments(String comments)
```
- getProperties
```
public Map<String,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(Map<String,String> properties)
```
- getDescriptors
```
public Map<String,PropertyDescriptorDTO> getDescriptors()
```
  Returns:
  
  descriptors for this processor's properties
- setDescriptors
```
public void setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)
```
- getSensitiveDynamicPropertyNames
```
public Set<String> getSensitiveDynamicPropertyNames()
```
  Returns:
  
  Set of sensitive dynamic property names
- setSensitiveDynamicPropertyNames
```
public void setSensitiveDynamicPropertyNames(Set<String> sensitiveDynamicPropertyNames)
```
- getAnnotationData
```
public String getAnnotationData()
```
  Annotation data for this processor.
  
  Returns:
  
  The annotation data
- setAnnotationData
```
public void setAnnotationData(String annotationData)
```
- getCustomUiUrl
```
public String getCustomUiUrl()
```
  Returns:
  
  the URL for this processors custom configuration UI if applicable. Null otherwise.
- setCustomUiUrl
```
public void setCustomUiUrl(String customUiUrl)
```
- getAutoTerminatedRelationships
```
public Set<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(Set<String> autoTerminatedRelationships)
```
- getDefaultConcurrentTasks
```
public Map<String,String> getDefaultConcurrentTasks()
```
  Returns:
  
  maps default values for concurrent tasks for each applicable scheduling strategy.
- setDefaultConcurrentTasks
```
public void setDefaultConcurrentTasks(Map<String,String> defaultConcurrentTasks)
```
- getRunDurationMillis
```
public Long getRunDurationMillis()
```
  Returns:
  
  run duration in milliseconds
- setRunDurationMillis
```
public void setRunDurationMillis(Long runDurationMillis)
```
- getDefaultSchedulingPeriod
```
public Map<String,String> getDefaultSchedulingPeriod()
```
  Returns:
  
  Maps default values for scheduling period for each applicable scheduling strategy
- setDefaultSchedulingPeriod
```
public void setDefaultSchedulingPeriod(Map<String,String> defaultSchedulingPeriod)
```
- getRetryCount
```
public Integer getRetryCount()
```
- setRetryCount
```
public void setRetryCount(Integer retryCount)
```
- getRetriedRelationships
```
public Set<String> getRetriedRelationships()
```
- setRetriedRelationships
```
public void setRetriedRelationships(Set<String> retriedRelationships)
```
- getBackoffMechanism
```
public String getBackoffMechanism()
```
- setBackoffMechanism
```
public void setBackoffMechanism(String backoffMechanism)
```
- getMaxBackoffPeriod
```
public String getMaxBackoffPeriod()
```
- setMaxBackoffPeriod
```
public void setMaxBackoffPeriod(String maxBackoffPeriod)
```

Class ProcessorConfigDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

properties

descriptors

sensitiveDynamicPropertyNames

schedulingPeriod

schedulingStrategy

executionNode

penaltyDuration

yieldDuration

bulletinLevel

runDurationMillis

concurrentlySchedulableTaskCount

autoTerminatedRelationships

comments

customUiUrl

lossTolerant

annotationData

defaultConcurrentTasks

defaultSchedulingPeriod

retryCount

retriedRelationships

backoffMechanism

maxBackoffPeriod

Constructor Detail

ProcessorConfigDTO

Method Detail

getSchedulingPeriod

setSchedulingPeriod

getSchedulingStrategy

setSchedulingStrategy

getExecutionNode

setExecutionNode

getPenaltyDuration

setPenaltyDuration

getYieldDuration

setYieldDuration

getBulletinLevel

setBulletinLevel

getConcurrentlySchedulableTaskCount

setConcurrentlySchedulableTaskCount

isLossTolerant

setLossTolerant

getComments

setComments

getProperties

setProperties

getDescriptors

setDescriptors

getSensitiveDynamicPropertyNames

setSensitiveDynamicPropertyNames

getAnnotationData

setAnnotationData

getCustomUiUrl

setCustomUiUrl

getAutoTerminatedRelationships

setAutoTerminatedRelationships

getDefaultConcurrentTasks

setDefaultConcurrentTasks

getRunDurationMillis

setRunDurationMillis

getDefaultSchedulingPeriod

setDefaultSchedulingPeriod

getRetryCount

setRetryCount

getRetriedRelationships

setRetriedRelationships

getBackoffMechanism

setBackoffMechanism

getMaxBackoffPeriod

setMaxBackoffPeriod