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

Class ProcessorDefinition

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

  • Field Details

    • group

      private String group

    • artifact

      private String artifact

    • version

      private String version

    • type

      private String type

    • typeDescription

      private String typeDescription

    • buildInfo

      private BuildInfo buildInfo

    • providedApiImplementations

      private List<DefinedType> providedApiImplementations

    • tags

      private List<String> tags

    • seeAlso

      private List<String> seeAlso

    • deprecated

      private Boolean deprecated

    • deprecationReason

      private String deprecationReason

    • deprecationAlternatives

      private List<String> deprecationAlternatives

    • restricted

      private Boolean restricted

    • restrictedExplanation

      private String restrictedExplanation

    • explicitRestrictions

      private List<Restriction> explicitRestrictions

    • stateful

      private Stateful stateful

    • systemResourceConsiderations

      private List<SystemResourceConsideration> systemResourceConsiderations

    • additionalDetails

      private Boolean additionalDetails

    • propertyDescriptors

      private Map<String,PropertyDescriptor> propertyDescriptors

    • supportsDynamicProperties

      private Boolean supportsDynamicProperties

    • supportsSensitiveDynamicProperties

      private Boolean supportsSensitiveDynamicProperties

    • dynamicProperties

      private List<DynamicProperty> dynamicProperties

    • inputRequirement

      private ProcessorDefinition.InputRequirementEnum inputRequirement

    • supportedRelationships

      private List<Relationship> supportedRelationships

    • supportsDynamicRelationships

      private Boolean supportsDynamicRelationships

    • dynamicRelationship

      private DynamicRelationship dynamicRelationship

    • triggerSerially

      private Boolean triggerSerially

    • triggerWhenEmpty

      private Boolean triggerWhenEmpty

    • triggerWhenAnyDestinationAvailable

      private Boolean triggerWhenAnyDestinationAvailable

    • supportsBatching

      private Boolean supportsBatching

    • primaryNodeOnly

      private Boolean primaryNodeOnly

    • sideEffectFree

      private Boolean sideEffectFree

    • supportedSchedulingStrategies

      private List<String> supportedSchedulingStrategies

    • defaultSchedulingStrategy

      private String defaultSchedulingStrategy

    • defaultConcurrentTasksBySchedulingStrategy

      private Map<String,Integer> defaultConcurrentTasksBySchedulingStrategy

    • defaultSchedulingPeriodBySchedulingStrategy

      private Map<String,String> defaultSchedulingPeriodBySchedulingStrategy

    • defaultPenaltyDuration

      private String defaultPenaltyDuration

    • defaultYieldDuration

      private String defaultYieldDuration

    • defaultBulletinLevel

      private String defaultBulletinLevel

    • readsAttributes

      private List<Attribute> readsAttributes

    • writesAttributes

      private List<Attribute> writesAttributes

  • Constructor Details

    • ProcessorDefinition

      public ProcessorDefinition()

  • Method Details

    • group

      public ProcessorDefinition group(String group)

    • getGroup

      public String getGroup()
      The group name of the bundle that provides the referenced type.
      Returns:
      group

    • setGroup

      public void setGroup(String group)

    • artifact

      public ProcessorDefinition artifact(String artifact)

    • getArtifact

      public String getArtifact()
      The artifact name of the bundle that provides the referenced type.
      Returns:
      artifact

    • setArtifact

      public void setArtifact(String artifact)

    • version

      public ProcessorDefinition version(String version)

    • getVersion

      public String getVersion()
      The version of the bundle that provides the referenced type.
      Returns:
      version

    • setVersion

      public void setVersion(String version)

    • type

      public ProcessorDefinition type(String type)

    • getType

      public String getType()
      The fully-qualified class type
      Returns:
      type

    • setType

      public void setType(String type)

    • typeDescription

      public ProcessorDefinition typeDescription(String typeDescription)

    • getTypeDescription

      public String getTypeDescription()
      The description of the type.
      Returns:
      typeDescription

    • setTypeDescription

      public void setTypeDescription(String typeDescription)

    • buildInfo

      public ProcessorDefinition buildInfo(BuildInfo buildInfo)

    • getBuildInfo

      public BuildInfo getBuildInfo()
      Get buildInfo
      Returns:
      buildInfo

    • setBuildInfo

      public void setBuildInfo(BuildInfo buildInfo)

    • providedApiImplementations

      public ProcessorDefinition providedApiImplementations(List<DefinedType> providedApiImplementations)

    • addProvidedApiImplementationsItem

      public ProcessorDefinition addProvidedApiImplementationsItem(DefinedType providedApiImplementationsItem)

    • getProvidedApiImplementations

      public List<DefinedType> getProvidedApiImplementations()
      If this type represents a provider for an interface, this lists the APIs it implements
      Returns:
      providedApiImplementations

    • setProvidedApiImplementations

      public void setProvidedApiImplementations(List<DefinedType> providedApiImplementations)

    • tags

      public ProcessorDefinition tags(List<String> tags)

    • addTagsItem

      public ProcessorDefinition addTagsItem(String tagsItem)

    • getTags

      public List<String> getTags()
      The tags associated with this type
      Returns:
      tags

    • setTags

      public void setTags(List<String> tags)

    • seeAlso

      public ProcessorDefinition seeAlso(List<String> seeAlso)

    • addSeeAlsoItem

      public ProcessorDefinition addSeeAlsoItem(String seeAlsoItem)

    • getSeeAlso

      public List<String> getSeeAlso()
      The names of other component types that may be related
      Returns:
      seeAlso

    • setSeeAlso

      public void setSeeAlso(List<String> seeAlso)

    • deprecated

      public ProcessorDefinition deprecated(Boolean deprecated)

    • isDeprecated

      public Boolean isDeprecated()
      Whether or not the component has been deprecated
      Returns:
      deprecated

    • setDeprecated

      public void setDeprecated(Boolean deprecated)

    • deprecationReason

      public ProcessorDefinition deprecationReason(String deprecationReason)

    • getDeprecationReason

      public String getDeprecationReason()
      If this component has been deprecated, this optional field can be used to provide an explanation
      Returns:
      deprecationReason

    • setDeprecationReason

      public void setDeprecationReason(String deprecationReason)

    • deprecationAlternatives

      public ProcessorDefinition deprecationAlternatives(List<String> deprecationAlternatives)

    • addDeprecationAlternativesItem

      public ProcessorDefinition addDeprecationAlternativesItem(String deprecationAlternativesItem)

    • getDeprecationAlternatives

      public List<String> getDeprecationAlternatives()
      If this component has been deprecated, this optional field provides alternatives to use
      Returns:
      deprecationAlternatives

    • setDeprecationAlternatives

      public void setDeprecationAlternatives(List<String> deprecationAlternatives)

    • restricted

      public ProcessorDefinition restricted(Boolean restricted)

    • isRestricted

      public Boolean isRestricted()
      Whether or not the component has a general restriction
      Returns:
      restricted

    • setRestricted

      public void setRestricted(Boolean restricted)

    • restrictedExplanation

      public ProcessorDefinition restrictedExplanation(String restrictedExplanation)

    • getRestrictedExplanation

      public String getRestrictedExplanation()
      An optional description of the general restriction
      Returns:
      restrictedExplanation

    • setRestrictedExplanation

      public void setRestrictedExplanation(String restrictedExplanation)

    • explicitRestrictions

      public ProcessorDefinition explicitRestrictions(List<Restriction> explicitRestrictions)

    • addExplicitRestrictionsItem

      public ProcessorDefinition addExplicitRestrictionsItem(Restriction explicitRestrictionsItem)

    • getExplicitRestrictions

      public List<Restriction> getExplicitRestrictions()
      Explicit restrictions that indicate a require permission to use the component
      Returns:
      explicitRestrictions

    • setExplicitRestrictions

      public void setExplicitRestrictions(List<Restriction> explicitRestrictions)

    • stateful

      public ProcessorDefinition stateful(Stateful stateful)

    • getStateful

      public Stateful getStateful()
      Get stateful
      Returns:
      stateful

    • setStateful

      public void setStateful(Stateful stateful)

    • systemResourceConsiderations

      public ProcessorDefinition systemResourceConsiderations(List<SystemResourceConsideration> systemResourceConsiderations)

    • addSystemResourceConsiderationsItem

      public ProcessorDefinition addSystemResourceConsiderationsItem(SystemResourceConsideration systemResourceConsiderationsItem)

    • getSystemResourceConsiderations

      public List<SystemResourceConsideration> getSystemResourceConsiderations()
      The system resource considerations for the given component
      Returns:
      systemResourceConsiderations

    • setSystemResourceConsiderations

      public void setSystemResourceConsiderations(List<SystemResourceConsideration> systemResourceConsiderations)

    • additionalDetails

      public ProcessorDefinition additionalDetails(Boolean additionalDetails)

    • isAdditionalDetails

      public Boolean isAdditionalDetails()
      Indicates if the component has additional details documentation
      Returns:
      additionalDetails

    • setAdditionalDetails

      public void setAdditionalDetails(Boolean additionalDetails)

    • propertyDescriptors

      public ProcessorDefinition propertyDescriptors(Map<String,PropertyDescriptor> propertyDescriptors)

    • putPropertyDescriptorsItem

      public ProcessorDefinition putPropertyDescriptorsItem(String key, PropertyDescriptor propertyDescriptorsItem)

    • getPropertyDescriptors

      public Map<String,PropertyDescriptor> getPropertyDescriptors()
      Descriptions of configuration properties applicable to this component.
      Returns:
      propertyDescriptors

    • setPropertyDescriptors

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

    • supportsDynamicProperties

      public ProcessorDefinition supportsDynamicProperties(Boolean supportsDynamicProperties)

    • isSupportsDynamicProperties

      public Boolean isSupportsDynamicProperties()
      Whether or not this component makes use of dynamic (user-set) properties.
      Returns:
      supportsDynamicProperties

    • setSupportsDynamicProperties

      public void setSupportsDynamicProperties(Boolean supportsDynamicProperties)

    • supportsSensitiveDynamicProperties

      public ProcessorDefinition supportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

    • isSupportsSensitiveDynamicProperties

      public Boolean isSupportsSensitiveDynamicProperties()
      Whether or not this component makes use of sensitive dynamic (user-set) properties.
      Returns:
      supportsSensitiveDynamicProperties

    • setSupportsSensitiveDynamicProperties

      public void setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

    • dynamicProperties

      public ProcessorDefinition dynamicProperties(List<DynamicProperty> dynamicProperties)

    • addDynamicPropertiesItem

      public ProcessorDefinition addDynamicPropertiesItem(DynamicProperty dynamicPropertiesItem)

    • getDynamicProperties

      public List<DynamicProperty> getDynamicProperties()
      Describes the dynamic properties supported by this component
      Returns:
      dynamicProperties

    • setDynamicProperties

      public void setDynamicProperties(List<DynamicProperty> dynamicProperties)

    • inputRequirement

      public ProcessorDefinition inputRequirement(ProcessorDefinition.InputRequirementEnum inputRequirement)

    • getInputRequirement

      public ProcessorDefinition.InputRequirementEnum getInputRequirement()
      Any input requirements this processor has.
      Returns:
      inputRequirement

    • setInputRequirement

      public void setInputRequirement(ProcessorDefinition.InputRequirementEnum inputRequirement)

    • supportedRelationships

      public ProcessorDefinition supportedRelationships(List<Relationship> supportedRelationships)

    • addSupportedRelationshipsItem

      public ProcessorDefinition addSupportedRelationshipsItem(Relationship supportedRelationshipsItem)

    • getSupportedRelationships

      public List<Relationship> getSupportedRelationships()
      The supported relationships for this processor.
      Returns:
      supportedRelationships

    • setSupportedRelationships

      public void setSupportedRelationships(List<Relationship> supportedRelationships)

    • supportsDynamicRelationships

      public ProcessorDefinition supportsDynamicRelationships(Boolean supportsDynamicRelationships)

    • isSupportsDynamicRelationships

      public Boolean isSupportsDynamicRelationships()
      Whether or not this processor supports dynamic relationships.
      Returns:
      supportsDynamicRelationships

    • setSupportsDynamicRelationships

      public void setSupportsDynamicRelationships(Boolean supportsDynamicRelationships)

    • dynamicRelationship

      public ProcessorDefinition dynamicRelationship(DynamicRelationship dynamicRelationship)

    • getDynamicRelationship

      public DynamicRelationship getDynamicRelationship()
      Get dynamicRelationship
      Returns:
      dynamicRelationship

    • setDynamicRelationship

      public void setDynamicRelationship(DynamicRelationship dynamicRelationship)

    • triggerSerially

      public ProcessorDefinition triggerSerially(Boolean triggerSerially)

    • isTriggerSerially

      public Boolean isTriggerSerially()
      Whether or not this processor should be triggered serially (i.e. no concurrent execution).
      Returns:
      triggerSerially

    • setTriggerSerially

      public void setTriggerSerially(Boolean triggerSerially)

    • triggerWhenEmpty

      public ProcessorDefinition triggerWhenEmpty(Boolean triggerWhenEmpty)

    • isTriggerWhenEmpty

      public Boolean isTriggerWhenEmpty()
      Whether or not this processor should be triggered when incoming queues are empty.
      Returns:
      triggerWhenEmpty

    • setTriggerWhenEmpty

      public void setTriggerWhenEmpty(Boolean triggerWhenEmpty)

    • triggerWhenAnyDestinationAvailable

      public ProcessorDefinition triggerWhenAnyDestinationAvailable(Boolean triggerWhenAnyDestinationAvailable)

    • isTriggerWhenAnyDestinationAvailable

      public Boolean isTriggerWhenAnyDestinationAvailable()
      Whether or not this processor should be triggered when any destination queue has room.
      Returns:
      triggerWhenAnyDestinationAvailable

    • setTriggerWhenAnyDestinationAvailable

      public void setTriggerWhenAnyDestinationAvailable(Boolean triggerWhenAnyDestinationAvailable)

    • supportsBatching

      public ProcessorDefinition supportsBatching(Boolean supportsBatching)

    • isSupportsBatching

      public Boolean isSupportsBatching()
      Whether or not this processor supports batching. If a Processor uses this annotation, it allows the Framework to batch calls to session commits, as well as allowing the Framework to return the same session multiple times.
      Returns:
      supportsBatching

    • setSupportsBatching

      public void setSupportsBatching(Boolean supportsBatching)

    • primaryNodeOnly

      public ProcessorDefinition primaryNodeOnly(Boolean primaryNodeOnly)

    • isPrimaryNodeOnly

      public Boolean isPrimaryNodeOnly()
      Whether or not this processor should be scheduled only on the primary node in a cluster.
      Returns:
      primaryNodeOnly

    • setPrimaryNodeOnly

      public void setPrimaryNodeOnly(Boolean primaryNodeOnly)

    • sideEffectFree

      public ProcessorDefinition sideEffectFree(Boolean sideEffectFree)

    • isSideEffectFree

      public Boolean isSideEffectFree()
      Whether or not this processor is considered side-effect free. Side-effect free indicate that the processor's operations on FlowFiles can be safely repeated across process sessions.
      Returns:
      sideEffectFree

    • setSideEffectFree

      public void setSideEffectFree(Boolean sideEffectFree)

    • supportedSchedulingStrategies

      public ProcessorDefinition supportedSchedulingStrategies(List<String> supportedSchedulingStrategies)

    • addSupportedSchedulingStrategiesItem

      public ProcessorDefinition addSupportedSchedulingStrategiesItem(String supportedSchedulingStrategiesItem)

    • getSupportedSchedulingStrategies

      public List<String> getSupportedSchedulingStrategies()
      The supported scheduling strategies, such as TIME_DRIVER, CRON, or EVENT_DRIVEN.
      Returns:
      supportedSchedulingStrategies

    • setSupportedSchedulingStrategies

      public void setSupportedSchedulingStrategies(List<String> supportedSchedulingStrategies)

    • defaultSchedulingStrategy

      public ProcessorDefinition defaultSchedulingStrategy(String defaultSchedulingStrategy)

    • getDefaultSchedulingStrategy

      public String getDefaultSchedulingStrategy()
      The default scheduling strategy for the processor.
      Returns:
      defaultSchedulingStrategy

    • setDefaultSchedulingStrategy

      public void setDefaultSchedulingStrategy(String defaultSchedulingStrategy)

    • defaultConcurrentTasksBySchedulingStrategy

      public ProcessorDefinition defaultConcurrentTasksBySchedulingStrategy(Map<String,Integer> defaultConcurrentTasksBySchedulingStrategy)

    • putDefaultConcurrentTasksBySchedulingStrategyItem

      public ProcessorDefinition putDefaultConcurrentTasksBySchedulingStrategyItem(String key, Integer defaultConcurrentTasksBySchedulingStrategyItem)

    • getDefaultConcurrentTasksBySchedulingStrategy

      public Map<String,Integer> getDefaultConcurrentTasksBySchedulingStrategy()
      The default concurrent tasks for each scheduling strategy.
      Returns:
      defaultConcurrentTasksBySchedulingStrategy

    • setDefaultConcurrentTasksBySchedulingStrategy

      public void setDefaultConcurrentTasksBySchedulingStrategy(Map<String,Integer> defaultConcurrentTasksBySchedulingStrategy)

    • defaultSchedulingPeriodBySchedulingStrategy

      public ProcessorDefinition defaultSchedulingPeriodBySchedulingStrategy(Map<String,String> defaultSchedulingPeriodBySchedulingStrategy)

    • putDefaultSchedulingPeriodBySchedulingStrategyItem

      public ProcessorDefinition putDefaultSchedulingPeriodBySchedulingStrategyItem(String key, String defaultSchedulingPeriodBySchedulingStrategyItem)

    • getDefaultSchedulingPeriodBySchedulingStrategy

      public Map<String,String> getDefaultSchedulingPeriodBySchedulingStrategy()
      The default scheduling period for each scheduling strategy. The scheduling period is expected to be a time period, such as \"30 sec\".
      Returns:
      defaultSchedulingPeriodBySchedulingStrategy

    • setDefaultSchedulingPeriodBySchedulingStrategy

      public void setDefaultSchedulingPeriodBySchedulingStrategy(Map<String,String> defaultSchedulingPeriodBySchedulingStrategy)

    • defaultPenaltyDuration

      public ProcessorDefinition defaultPenaltyDuration(String defaultPenaltyDuration)

    • getDefaultPenaltyDuration

      public String getDefaultPenaltyDuration()
      The default penalty duration as a time period, such as \"30 sec\".
      Returns:
      defaultPenaltyDuration

    • setDefaultPenaltyDuration

      public void setDefaultPenaltyDuration(String defaultPenaltyDuration)

    • defaultYieldDuration

      public ProcessorDefinition defaultYieldDuration(String defaultYieldDuration)

    • getDefaultYieldDuration

      public String getDefaultYieldDuration()
      The default yield duration as a time period, such as \"1 sec\".
      Returns:
      defaultYieldDuration

    • setDefaultYieldDuration

      public void setDefaultYieldDuration(String defaultYieldDuration)

    • defaultBulletinLevel

      public ProcessorDefinition defaultBulletinLevel(String defaultBulletinLevel)

    • getDefaultBulletinLevel

      public String getDefaultBulletinLevel()
      The default bulletin level, such as WARN, INFO, DEBUG, etc.
      Returns:
      defaultBulletinLevel

    • setDefaultBulletinLevel

      public void setDefaultBulletinLevel(String defaultBulletinLevel)

    • readsAttributes

      public ProcessorDefinition readsAttributes(List<Attribute> readsAttributes)

    • addReadsAttributesItem

      public ProcessorDefinition addReadsAttributesItem(Attribute readsAttributesItem)

    • getReadsAttributes

      public List<Attribute> getReadsAttributes()
      The FlowFile attributes this processor reads
      Returns:
      readsAttributes

    • setReadsAttributes

      public void setReadsAttributes(List<Attribute> readsAttributes)

    • writesAttributes

      public ProcessorDefinition writesAttributes(List<Attribute> writesAttributes)

    • addWritesAttributesItem

      public ProcessorDefinition addWritesAttributesItem(Attribute writesAttributesItem)

    • getWritesAttributes

      public List<Attribute> getWritesAttributes()
      The FlowFile attributes this processor writes/updates
      Returns:
      writesAttributes

    • setWritesAttributes

      public void setWritesAttributes(List<Attribute> writesAttributes)

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