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

Class VersionedProcessor

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

  • Field Details

  • Constructor Details

    • VersionedProcessor

      public VersionedProcessor()

  • Method Details

    • identifier

      public VersionedProcessor identifier(String identifier)

    • getIdentifier

      public String getIdentifier()
      The component's unique identifier
      Returns:
      identifier

    • setIdentifier

      public void setIdentifier(String identifier)

    • instanceIdentifier

      public VersionedProcessor instanceIdentifier(String instanceIdentifier)

    • getInstanceIdentifier

      public String getInstanceIdentifier()
      The instance ID of an existing component that is described by this VersionedComponent, or null if this is not mapped to an instantiated component
      Returns:
      instanceIdentifier

    • setInstanceIdentifier

      public void setInstanceIdentifier(String instanceIdentifier)

    • name

      public VersionedProcessor name(String name)

    • getName

      public String getName()
      The component's name
      Returns:
      name

    • setName

      public void setName(String name)

    • comments

      public VersionedProcessor comments(String comments)

    • getComments

      public String getComments()
      The user-supplied comments for the component
      Returns:
      comments

    • setComments

      public void setComments(String comments)

    • position

      public VersionedProcessor position(Position position)

    • getPosition

      public Position getPosition()
      Get position
      Returns:
      position

    • setPosition

      public void setPosition(Position position)

    • type

      public VersionedProcessor type(String type)

    • getType

      public String getType()
      The type of the extension component
      Returns:
      type

    • setType

      public void setType(String type)

    • bundle

      public VersionedProcessor bundle(Bundle bundle)

    • getBundle

      public Bundle getBundle()
      Get bundle
      Returns:
      bundle

    • setBundle

      public void setBundle(Bundle bundle)

    • properties

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

    • putPropertiesItem

      public VersionedProcessor putPropertiesItem(String key, String propertiesItem)

    • getProperties

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

    • setProperties

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

    • propertyDescriptors

      public VersionedProcessor propertyDescriptors(Map<String,VersionedPropertyDescriptor> propertyDescriptors)

    • putPropertyDescriptorsItem

      public VersionedProcessor putPropertyDescriptorsItem(String key, VersionedPropertyDescriptor propertyDescriptorsItem)

    • getPropertyDescriptors

      public Map<String,VersionedPropertyDescriptor> getPropertyDescriptors()
      The property descriptors for the component.
      Returns:
      propertyDescriptors

    • setPropertyDescriptors

      public void setPropertyDescriptors(Map<String,VersionedPropertyDescriptor> propertyDescriptors)

    • style

      public VersionedProcessor style(Map<String,String> style)

    • putStyleItem

      public VersionedProcessor putStyleItem(String key, String styleItem)

    • getStyle

      public Map<String,String> getStyle()
      Stylistic data for rendering in a UI
      Returns:
      style

    • setStyle

      public void setStyle(Map<String,String> style)

    • annotationData

      public VersionedProcessor 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)

    • schedulingPeriod

      public VersionedProcessor 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 VersionedProcessor 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 VersionedProcessor 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 VersionedProcessor penaltyDuration(String penaltyDuration)

    • getPenaltyDuration

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

    • setPenaltyDuration

      public void setPenaltyDuration(String penaltyDuration)

    • yieldDuration

      public VersionedProcessor 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 VersionedProcessor 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 VersionedProcessor 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 VersionedProcessor 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 VersionedProcessor autoTerminatedRelationships(List<String> autoTerminatedRelationships)

    • addAutoTerminatedRelationshipsItem

      public VersionedProcessor 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)

    • scheduledState

      public VersionedProcessor scheduledState(VersionedProcessor.ScheduledStateEnum scheduledState)

    • getScheduledState

      public VersionedProcessor.ScheduledStateEnum getScheduledState()
      The scheduled state of the component
      Returns:
      scheduledState

    • setScheduledState

      public void setScheduledState(VersionedProcessor.ScheduledStateEnum scheduledState)

    • retryCount

      public VersionedProcessor retryCount(Integer retryCount)

    • getRetryCount

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

    • setRetryCount

      public void setRetryCount(Integer retryCount)

    • retriedRelationships

      public VersionedProcessor retriedRelationships(List<String> retriedRelationships)

    • addRetriedRelationshipsItem

      public VersionedProcessor addRetriedRelationshipsItem(String retriedRelationshipsItem)

    • getRetriedRelationships

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

    • setRetriedRelationships

      public void setRetriedRelationships(List<String> retriedRelationships)

    • backoffMechanism

      public VersionedProcessor backoffMechanism(VersionedProcessor.BackoffMechanismEnum backoffMechanism)

    • getBackoffMechanism

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

    • setBackoffMechanism

      public void setBackoffMechanism(VersionedProcessor.BackoffMechanismEnum backoffMechanism)

    • maxBackoffPeriod

      public VersionedProcessor 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)

    • componentType

      public VersionedProcessor componentType(VersionedProcessor.ComponentTypeEnum componentType)

    • getComponentType

      public VersionedProcessor.ComponentTypeEnum getComponentType()
      Get componentType
      Returns:
      componentType

    • setComponentType

      public void setComponentType(VersionedProcessor.ComponentTypeEnum componentType)

    • groupIdentifier

      public VersionedProcessor groupIdentifier(String groupIdentifier)

    • getGroupIdentifier

      public String getGroupIdentifier()
      The ID of the Process Group that this component belongs to
      Returns:
      groupIdentifier

    • setGroupIdentifier

      public void setGroupIdentifier(String groupIdentifier)

    • 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).