org.apache.nifi.web.api.dto

Class ParameterProviderDTO

java.lang.Object

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

org.apache.nifi.web.api.dto.ParameterProviderDTO

public class ParameterProviderDTO
extends ComponentDTO

Component that is capable of providing parameters to NiFi from an external source

Field Summary

Fields

Modifier and Type	Field and Description
private Set<AffectedComponentEntity>	affectedComponents
private String	annotationData
private BundleDTO	bundle
private String	comments
private String	customUiUrl
private Boolean	deprecated
private Map<String,PropertyDescriptorDTO>	descriptors
static String	INVALID
private Boolean	isExtensionMissing
private Boolean	multipleVersionsAvailable
private String	name
private Collection<ParameterGroupConfigurationEntity>	parameterGroupConfigurations
private Set<ParameterStatusDTO>	parameterStatus
private Boolean	persistsState
private Map<String,String>	properties
private Set<ParameterProviderReferencingComponentEntity>	referencingParameterContexts
private Boolean	restricted
private String	type
static String	VALID
static String	VALIDATING
private Collection<String>	validationErrors
private String	validationStatus

Constructor Summary

Constructors

Constructor and Description
ParameterProviderDTO()

Method Summary

Modifier and Type	Method and Description
Set<AffectedComponentEntity>	getAffectedComponents()
String	getAnnotationData()
BundleDTO	getBundle() The details of the artifact that bundled this parameter provider type.
String	getComments()
String	getCustomUiUrl()
Boolean	getDeprecated()
Map<String,PropertyDescriptorDTO>	getDescriptors()
Boolean	getExtensionMissing()
Boolean	getMultipleVersionsAvailable()
String	getName()
Collection<ParameterGroupConfigurationEntity>	getParameterGroupConfigurations()
Set<ParameterStatusDTO>	getParameterStatus()
Boolean	getPersistsState()
Map<String,String>	getProperties()
Set<ParameterProviderReferencingComponentEntity>	getReferencingParameterContexts()
Boolean	getRestricted()
String	getType()
Collection<String>	getValidationErrors() Gets the validation errors from this parameter provider.
String	getValidationStatus()
void	setAffectedComponents(Set<AffectedComponentEntity> affectedComponents)
void	setAnnotationData(String annotationData)
void	setBundle(BundleDTO bundle)
void	setComments(String comments)
void	setCustomUiUrl(String customUiUrl)
void	setDeprecated(Boolean deprecated)
void	setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)
void	setExtensionMissing(Boolean extensionMissing)
void	setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)
void	setName(String name)
void	setParameterGroupConfigurations(Collection<ParameterGroupConfigurationEntity> parameterGroupConfigurations)
void	setParameterStatus(Set<ParameterStatusDTO> parameterStatus)
void	setPersistsState(Boolean persistsState)
void	setProperties(Map<String,String> properties)
void	setReferencingParameterContexts(Set<ParameterProviderReferencingComponentEntity> referencingParameterContexts)
void	setRestricted(Boolean restricted)
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

comments

private String comments

persistsState

private Boolean persistsState

restricted

private Boolean restricted

deprecated

private Boolean deprecated

isExtensionMissing

private Boolean isExtensionMissing

multipleVersionsAvailable

private Boolean multipleVersionsAvailable

properties

private Map<String,String> properties

descriptors

private Map<String,PropertyDescriptorDTO> descriptors

parameterGroupConfigurations

private Collection<ParameterGroupConfigurationEntity> parameterGroupConfigurations

affectedComponents

private Set<AffectedComponentEntity> affectedComponents

parameterStatus

private Set<ParameterStatusDTO> parameterStatus

referencingParameterContexts

private Set<ParameterProviderReferencingComponentEntity> referencingParameterContexts

customUiUrl

private String customUiUrl

annotationData

private String annotationData

validationErrors

private Collection<String> validationErrors

validationStatus

private String validationStatus

Constructor Detail

ParameterProviderDTO

public ParameterProviderDTO()

Method Detail

getName

public String getName()

Returns:

user-defined name of the parameter provider

setName

public void setName(String name)

getAffectedComponents

public Set<AffectedComponentEntity> getAffectedComponents()

setAffectedComponents

public void setAffectedComponents(Set<AffectedComponentEntity> affectedComponents)

setReferencingParameterContexts

public void setReferencingParameterContexts(Set<ParameterProviderReferencingComponentEntity> referencingParameterContexts)

getParameterStatus

public Set<ParameterStatusDTO> getParameterStatus()

setParameterStatus

public void setParameterStatus(Set<ParameterStatusDTO> parameterStatus)

getReferencingParameterContexts

public Set<ParameterProviderReferencingComponentEntity> getReferencingParameterContexts()

getParameterGroupConfigurations

public Collection<ParameterGroupConfigurationEntity> getParameterGroupConfigurations()

setParameterGroupConfigurations

public void setParameterGroupConfigurations(Collection<ParameterGroupConfigurationEntity> parameterGroupConfigurations)

getComments

public String getComments()

Returns:

user-defined comments for the parameter provider

setComments

public void setComments(String comments)

getType

public String getType()

Returns:

type of parameter provider

setType

public void setType(String type)

getBundle

public BundleDTO getBundle()

The details of the artifact that bundled this parameter provider type.

Returns:

The bundle details

setBundle

public void setBundle(BundleDTO bundle)

getPersistsState

public Boolean getPersistsState()

Returns:

whether this parameter provider persists state

setPersistsState

public void setPersistsState(Boolean persistsState)

getRestricted

public Boolean getRestricted()

Returns:

whether this parameter provider requires elevated privileges

setRestricted

public void setRestricted(Boolean restricted)

getDeprecated

public Boolean getDeprecated()

Returns:

Whether the parameter provider has been deprecated.

setDeprecated

public void setDeprecated(Boolean deprecated)

getExtensionMissing

public Boolean getExtensionMissing()

Returns:

whether the underlying extension is missing

setExtensionMissing

public void setExtensionMissing(Boolean extensionMissing)

getMultipleVersionsAvailable

public Boolean getMultipleVersionsAvailable()

Returns:

whether this parameter provider has multiple versions available

setMultipleVersionsAvailable

public void setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)

getProperties

public Map<String,String> getProperties()

Returns:

parameter provider's properties

setProperties

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

getDescriptors

public Map<String,PropertyDescriptorDTO> getDescriptors()

Returns:

Map of property name to descriptor

setDescriptors

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

getCustomUiUrl

public String getCustomUiUrl()

Returns:

the URL for this parameter provider custom configuration UI if applicable. Null otherwise

setCustomUiUrl

public void setCustomUiUrl(String customUiUrl)

getAnnotationData

public String getAnnotationData()

Returns:

currently configured annotation data for the parameter provider

setAnnotationData

public void setAnnotationData(String annotationData)

getValidationErrors

public Collection<String> getValidationErrors()

Gets the validation errors from this parameter provider. These validation errors represent the problems with the parameter provider that must be resolved before it can be scheduled to run.

Returns:

The validation errors

setValidationErrors

public void setValidationErrors(Collection<String> validationErrors)

getValidationStatus

public String getValidationStatus()

setValidationStatus

public void setValidationStatus(String validationStatus)