org.apache.nifi.web.api.dto

Class ProcessorDTO

java.lang.Object

org.apache.nifi.web.api.dto.ComponentDTO

org.apache.nifi.web.api.dto.ProcessorDTO

public class ProcessorDTO
extends ComponentDTO

Details for a processor within this NiFi.

Field Summary

Fields

Modifier and Type	Field and Description
private BundleDTO	bundle
private ProcessorConfigDTO	config
private Boolean	deprecated
private String	description
private Boolean	executionNodeRestricted
private String	inputRequirement
static String	INVALID
private Boolean	isExtensionMissing
private Boolean	multipleVersionsAvailable
private String	name
private Boolean	persistsState
private List<RelationshipDTO>	relationships
private Boolean	restricted
private String	state
private Map<String,String>	style
private Boolean	supportsBatching
private Boolean	supportsEventDriven
private Boolean	supportsParallelProcessing
private Boolean	supportsSensitiveDynamicProperties
private String	type
static String	VALID
static String	VALIDATING
private Collection<String>	validationErrors
private String	validationStatus

Constructor Summary

Constructors

Constructor and Description
ProcessorDTO()

Method Summary

Modifier and Type	Method and Description
BundleDTO	getBundle() The details of the artifact that bundled this processor type.
ProcessorConfigDTO	getConfig() The configuration details for this processor.
Boolean	getDeprecated()
String	getDescription()
Boolean	getExtensionMissing()
String	getInputRequirement()
Boolean	getMultipleVersionsAvailable()
String	getName() The name of this processor.
Boolean	getPersistsState()
List<RelationshipDTO>	getRelationships() Gets the available relationships that this processor currently supports.
Boolean	getRestricted()
String	getState()
Map<String,String>	getStyle()
Boolean	getSupportsBatching()
Boolean	getSupportsEventDriven()
Boolean	getSupportsParallelProcessing()
Boolean	getSupportsSensitiveDynamicProperties()
String	getType() The type of this processor.
Collection<String>	getValidationErrors() Gets the validation errors from this processor.
String	getValidationStatus()
Boolean	isExecutionNodeRestricted()
void	setBundle(BundleDTO bundle)
void	setConfig(ProcessorConfigDTO config)
void	setDeprecated(Boolean deprecated)
void	setDescription(String description)
void	setExecutionNodeRestricted(Boolean executionNodeRestricted)
void	setExtensionMissing(Boolean extensionMissing)
void	setInputRequirement(String inputRequirement)
void	setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)
void	setName(String name)
void	setPersistsState(Boolean persistsState)
void	setRelationships(List<RelationshipDTO> relationships)
void	setRestricted(Boolean restricted)
void	setState(String state)
void	setStyle(Map<String,String> style)
void	setSupportsBatching(Boolean supportsBatching)
void	setSupportsEventDriven(Boolean supportsEventDriven)
void	setSupportsParallelProcessing(Boolean supportsParallelProcessing)
void	setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)
void	setType(String type)
void	setValidationErrors(Collection<String> validationErrors)
void	setValidationStatus(String validationStatus)

Methods inherited from class org.apache.nifi.web.api.dto.ComponentDTO

equals, getId, getParentGroupId, getPosition, getVersionedComponentId, hashCode, setId, setParentGroupId, setPosition, setVersionedComponentId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VALID

public static final String VALID

See Also:

Constant Field Values

INVALID

public static final String INVALID

See Also:

Constant Field Values

VALIDATING

public static final String VALIDATING

See Also:

Constant Field Values

name

private String name

type

private String type

bundle

private BundleDTO bundle

state

private String state

style

private Map<String,String> style

relationships

private List<RelationshipDTO> relationships

description

private String description

supportsParallelProcessing

private Boolean supportsParallelProcessing

supportsEventDriven

private Boolean supportsEventDriven

supportsBatching

private Boolean supportsBatching

supportsSensitiveDynamicProperties

private Boolean supportsSensitiveDynamicProperties

persistsState

private Boolean persistsState

restricted

private Boolean restricted

deprecated

private Boolean deprecated

isExtensionMissing

private Boolean isExtensionMissing

executionNodeRestricted

private Boolean executionNodeRestricted

multipleVersionsAvailable

private Boolean multipleVersionsAvailable

inputRequirement

private String inputRequirement

config

private ProcessorConfigDTO config

validationErrors

private Collection<String> validationErrors

validationStatus

private String validationStatus

Constructor Detail

ProcessorDTO

public ProcessorDTO()

Method Detail

getName

public String getName()

The name of this processor.

Returns:

This processors name

setName

public void setName(String name)

getType

public String getType()

The type of this processor.

Returns:

This processors type

setType

public void setType(String type)

getBundle

public BundleDTO getBundle()

The details of the artifact that bundled this processor type.

Returns:

The bundle details

setBundle

public void setBundle(BundleDTO bundle)

getState

public String getState()

Returns:

The state of this processor. Possible states are 'RUNNING', 'STOPPED', and 'DISABLED'

setState

public void setState(String state)

getStyle

public Map<String,String> getStyle()

Returns:

The styles for this processor. (Currently only supports color)

setStyle

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

getSupportsParallelProcessing

public Boolean getSupportsParallelProcessing()

Returns:

whether this processor supports parallel processing

setSupportsParallelProcessing

public void setSupportsParallelProcessing(Boolean supportsParallelProcessing)

getSupportsSensitiveDynamicProperties

public Boolean getSupportsSensitiveDynamicProperties()

Returns:

whether this processor supports sensitive dynamic properties

setSupportsSensitiveDynamicProperties

public void setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

getPersistsState

public Boolean getPersistsState()

Returns:

whether this processor persists state

setPersistsState

public void setPersistsState(Boolean persistsState)

getMultipleVersionsAvailable

public Boolean getMultipleVersionsAvailable()

Returns:

whether this processor has multiple versions available

setMultipleVersionsAvailable

public void setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)

getExtensionMissing

public Boolean getExtensionMissing()

Returns:

whether the underlying extension is missing

setExtensionMissing

public void setExtensionMissing(Boolean extensionMissing)

getRestricted

public Boolean getRestricted()

Returns:

whether this processor requires elevated privileges

setRestricted

public void setRestricted(Boolean restricted)

getDeprecated

public Boolean getDeprecated()

Returns:

Whether the processor has been deprecated.

setDeprecated

public void setDeprecated(Boolean deprecated)

getInputRequirement

public String getInputRequirement()

Returns:

the input requirement of this processor

setInputRequirement

public void setInputRequirement(String inputRequirement)

getSupportsEventDriven

public Boolean getSupportsEventDriven()

Returns:

whether this processor supports event driven scheduling

setSupportsEventDriven

public void setSupportsEventDriven(Boolean supportsEventDriven)

getSupportsBatching

public Boolean getSupportsBatching()

Returns:

whether this processor supports batching

setSupportsBatching

public void setSupportsBatching(Boolean supportsBatching)

getRelationships

public List<RelationshipDTO> getRelationships()

Gets the available relationships that this processor currently supports.

Returns:

The available relationships

setRelationships

public void setRelationships(List<RelationshipDTO> relationships)

getConfig

public ProcessorConfigDTO getConfig()

The configuration details for this processor. These details will be included in a response if the verbose flag is set to true.

Returns:

The processor configuration details

setConfig

public void setConfig(ProcessorConfigDTO config)

getValidationErrors

public Collection<String> getValidationErrors()

Gets the validation errors from this processor. These validation errors represent the problems with the processor that must be resolved before it can be started.

Returns:

The validation errors

setValidationErrors

public void setValidationErrors(Collection<String> validationErrors)

getValidationStatus

public String getValidationStatus()

setValidationStatus

public void setValidationStatus(String validationStatus)

getDescription

public String getDescription()

Returns:

the description for this processor

setDescription

public void setDescription(String description)

isExecutionNodeRestricted

public Boolean isExecutionNodeRestricted()

Returns:

whether or not this processor is restricted to run only in primary node

setExecutionNodeRestricted

public void setExecutionNodeRestricted(Boolean executionNodeRestricted)