Package org.apache.nifi.api.toolkit.model

Class ProcessorConfigDTO

java.lang.Object
org.apache.nifi.api.toolkit.model.ProcessorConfigDTO
@Generated(value="io.swagger.codegen.v3.generators.java.JavaClientCodegen", date="2023-11-22T19:25:26.907436939-06:00[America/Chicago]") public class ProcessorConfigDTO extends Object
ProcessorConfigDTO

  • Field Details

    • properties

      private Map<String,String> properties

    • descriptors

      private Map<String,PropertyDescriptorDTO> descriptors

    • sensitiveDynamicPropertyNames

      private List<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 List<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 List<String> retriedRelationships

    • backoffMechanism

      private ProcessorConfigDTO.BackoffMechanismEnum backoffMechanism

    • maxBackoffPeriod

      private String maxBackoffPeriod

  • Constructor Details

    • ProcessorConfigDTO

      public ProcessorConfigDTO()

  • Method Details

    • properties

      public ProcessorConfigDTO properties(Map<String,String> properties)

    • putPropertiesItem

      public ProcessorConfigDTO putPropertiesItem(String key, String propertiesItem)

    • getProperties

      public Map<String,String> getProperties()
      The properties for the processor. Properties whose value is not set will only contain the property name.
      Returns:
      properties

    • setProperties

      public void setProperties(Map<String,String> properties)

    • descriptors

      public ProcessorConfigDTO descriptors(Map<String,PropertyDescriptorDTO> descriptors)

    • putDescriptorsItem

      public ProcessorConfigDTO putDescriptorsItem(String key, PropertyDescriptorDTO descriptorsItem)

    • getDescriptors

      public Map<String,PropertyDescriptorDTO> getDescriptors()
      Descriptors for the processor's properties.
      Returns:
      descriptors

    • setDescriptors

      public void setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)

    • sensitiveDynamicPropertyNames

      public ProcessorConfigDTO sensitiveDynamicPropertyNames(List<String> sensitiveDynamicPropertyNames)

    • addSensitiveDynamicPropertyNamesItem

      public ProcessorConfigDTO addSensitiveDynamicPropertyNamesItem(String sensitiveDynamicPropertyNamesItem)

    • getSensitiveDynamicPropertyNames

      public List<String> getSensitiveDynamicPropertyNames()
      Set of sensitive dynamic property names
      Returns:
      sensitiveDynamicPropertyNames

    • setSensitiveDynamicPropertyNames

      public void setSensitiveDynamicPropertyNames(List<String> sensitiveDynamicPropertyNames)

    • schedulingPeriod

      public ProcessorConfigDTO schedulingPeriod(String schedulingPeriod)

    • getSchedulingPeriod

      public String getSchedulingPeriod()
      The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.
      Returns:
      schedulingPeriod

    • setSchedulingPeriod

      public void setSchedulingPeriod(String schedulingPeriod)

    • schedulingStrategy

      public ProcessorConfigDTO schedulingStrategy(String schedulingStrategy)

    • getSchedulingStrategy

      public String getSchedulingStrategy()
      Indicates how the processor should be scheduled to run.
      Returns:
      schedulingStrategy

    • setSchedulingStrategy

      public void setSchedulingStrategy(String schedulingStrategy)

    • executionNode

      public ProcessorConfigDTO executionNode(String executionNode)

    • getExecutionNode

      public String getExecutionNode()
      Indicates the node where the process will execute.
      Returns:
      executionNode

    • setExecutionNode

      public void setExecutionNode(String executionNode)

    • penaltyDuration

      public ProcessorConfigDTO penaltyDuration(String penaltyDuration)

    • getPenaltyDuration

      public String getPenaltyDuration()
      The amount of time that is used when the process penalizes a flowfile.
      Returns:
      penaltyDuration

    • setPenaltyDuration

      public void setPenaltyDuration(String penaltyDuration)

    • yieldDuration

      public ProcessorConfigDTO yieldDuration(String yieldDuration)

    • getYieldDuration

      public String getYieldDuration()
      The amount of time that must elapse before this processor is scheduled again after yielding.
      Returns:
      yieldDuration

    • setYieldDuration

      public void setYieldDuration(String yieldDuration)

    • bulletinLevel

      public ProcessorConfigDTO bulletinLevel(String bulletinLevel)

    • getBulletinLevel

      public String getBulletinLevel()
      The level at which the processor will report bulletins.
      Returns:
      bulletinLevel

    • setBulletinLevel

      public void setBulletinLevel(String bulletinLevel)

    • runDurationMillis

      public ProcessorConfigDTO runDurationMillis(Long runDurationMillis)

    • getRunDurationMillis

      public Long getRunDurationMillis()
      The run duration for the processor in milliseconds.
      Returns:
      runDurationMillis

    • setRunDurationMillis

      public void setRunDurationMillis(Long runDurationMillis)

    • concurrentlySchedulableTaskCount

      public ProcessorConfigDTO concurrentlySchedulableTaskCount(Integer concurrentlySchedulableTaskCount)

    • getConcurrentlySchedulableTaskCount

      public Integer getConcurrentlySchedulableTaskCount()
      The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored.
      Returns:
      concurrentlySchedulableTaskCount

    • setConcurrentlySchedulableTaskCount

      public void setConcurrentlySchedulableTaskCount(Integer concurrentlySchedulableTaskCount)

    • autoTerminatedRelationships

      public ProcessorConfigDTO autoTerminatedRelationships(List<String> autoTerminatedRelationships)

    • addAutoTerminatedRelationshipsItem

      public ProcessorConfigDTO addAutoTerminatedRelationshipsItem(String autoTerminatedRelationshipsItem)

    • getAutoTerminatedRelationships

      public List<String> getAutoTerminatedRelationships()
      The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.
      Returns:
      autoTerminatedRelationships

    • setAutoTerminatedRelationships

      public void setAutoTerminatedRelationships(List<String> autoTerminatedRelationships)

    • comments

      public ProcessorConfigDTO comments(String comments)

    • getComments

      public String getComments()
      The comments for the processor.
      Returns:
      comments

    • setComments

      public void setComments(String comments)

    • customUiUrl

      public ProcessorConfigDTO customUiUrl(String customUiUrl)

    • getCustomUiUrl

      public String getCustomUiUrl()
      The URL for the processor's custom configuration UI if applicable.
      Returns:
      customUiUrl

    • setCustomUiUrl

      public void setCustomUiUrl(String customUiUrl)

    • lossTolerant

      public ProcessorConfigDTO lossTolerant(Boolean lossTolerant)

    • isLossTolerant

      public Boolean isLossTolerant()
      Whether the processor is loss tolerant.
      Returns:
      lossTolerant

    • setLossTolerant

      public void setLossTolerant(Boolean lossTolerant)

    • annotationData

      public ProcessorConfigDTO annotationData(String annotationData)

    • getAnnotationData

      public String getAnnotationData()
      The annotation data for the processor used to relay configuration between a custom UI and the procesosr.
      Returns:
      annotationData

    • setAnnotationData

      public void setAnnotationData(String annotationData)

    • defaultConcurrentTasks

      public ProcessorConfigDTO defaultConcurrentTasks(Map<String,String> defaultConcurrentTasks)

    • putDefaultConcurrentTasksItem

      public ProcessorConfigDTO putDefaultConcurrentTasksItem(String key, String defaultConcurrentTasksItem)

    • getDefaultConcurrentTasks

      public Map<String,String> getDefaultConcurrentTasks()
      Maps default values for concurrent tasks for each applicable scheduling strategy.
      Returns:
      defaultConcurrentTasks

    • setDefaultConcurrentTasks

      public void setDefaultConcurrentTasks(Map<String,String> defaultConcurrentTasks)

    • defaultSchedulingPeriod

      public ProcessorConfigDTO defaultSchedulingPeriod(Map<String,String> defaultSchedulingPeriod)

    • putDefaultSchedulingPeriodItem

      public ProcessorConfigDTO putDefaultSchedulingPeriodItem(String key, String defaultSchedulingPeriodItem)

    • getDefaultSchedulingPeriod

      public Map<String,String> getDefaultSchedulingPeriod()
      Maps default values for scheduling period for each applicable scheduling strategy.
      Returns:
      defaultSchedulingPeriod

    • setDefaultSchedulingPeriod

      public void setDefaultSchedulingPeriod(Map<String,String> defaultSchedulingPeriod)

    • retryCount

      public ProcessorConfigDTO retryCount(Integer retryCount)

    • getRetryCount

      public Integer getRetryCount()
      Overall number of retries.
      Returns:
      retryCount

    • setRetryCount

      public void setRetryCount(Integer retryCount)

    • retriedRelationships

      public ProcessorConfigDTO retriedRelationships(List<String> retriedRelationships)

    • addRetriedRelationshipsItem

      public ProcessorConfigDTO addRetriedRelationshipsItem(String retriedRelationshipsItem)

    • getRetriedRelationships

      public List<String> getRetriedRelationships()
      All the relationships should be retried.
      Returns:
      retriedRelationships

    • setRetriedRelationships

      public void setRetriedRelationships(List<String> retriedRelationships)

    • getBackoffMechanism

      public ProcessorConfigDTO.BackoffMechanismEnum getBackoffMechanism()
      Determines whether the FlowFile should be penalized or the processor should be yielded between retries.
      Returns:
      backoffMechanism

    • maxBackoffPeriod

      public ProcessorConfigDTO maxBackoffPeriod(String maxBackoffPeriod)

    • getMaxBackoffPeriod

      public String getMaxBackoffPeriod()
      Maximum amount of time to be waited during a retry period.
      Returns:
      maxBackoffPeriod

    • setMaxBackoffPeriod

      public void setMaxBackoffPeriod(String maxBackoffPeriod)

    • 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

    • toIndentedString

      private String toIndentedString(Object o)
      Convert the given object to string with each line indented by 4 spaces (except the first line).