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

Class ParameterProviderDTO

java.lang.Object

org.apache.nifi.api.toolkit.model.ParameterProviderDTO

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

ParameterProviderDTO

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ParameterProviderDTO.ValidationStatusEnum	Indicates whether the Parameter Provider is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Parameter Provider is valid)

Field Summary

Fields

Modifier and Type	Field	Description
private List<AffectedComponentEntity>	affectedComponents
private String	annotationData
private BundleDTO	bundle
private String	comments
private String	customUiUrl
private Boolean	deprecated
private Map<String,PropertyDescriptorDTO>	descriptors
private Boolean	extensionMissing
private String	id
private Boolean	multipleVersionsAvailable
private String	name
private List<ParameterGroupConfigurationEntity>	parameterGroupConfigurations
private List<ParameterStatusDTO>	parameterStatus
private String	parentGroupId
private Boolean	persistsState
private PositionDTO	position
private Map<String,String>	properties
private List<ParameterProviderReferencingComponentEntity>	referencingParameterContexts
private Boolean	restricted
private String	type
private List<String>	validationErrors
private ParameterProviderDTO.ValidationStatusEnum	validationStatus
private String	versionedComponentId

Constructor Summary

Constructors

Constructor	Description
ParameterProviderDTO()

Method Summary

Modifier and Type	Method	Description
ParameterProviderDTO	addAffectedComponentsItem(AffectedComponentEntity affectedComponentsItem)
ParameterProviderDTO	addParameterGroupConfigurationsItem(ParameterGroupConfigurationEntity parameterGroupConfigurationsItem)
ParameterProviderDTO	addParameterStatusItem(ParameterStatusDTO parameterStatusItem)
ParameterProviderDTO	addValidationErrorsItem(String validationErrorsItem)
ParameterProviderDTO	affectedComponents(List<AffectedComponentEntity> affectedComponents)
ParameterProviderDTO	annotationData(String annotationData)
ParameterProviderDTO	bundle(BundleDTO bundle)
ParameterProviderDTO	comments(String comments)
ParameterProviderDTO	customUiUrl(String customUiUrl)
ParameterProviderDTO	deprecated(Boolean deprecated)
ParameterProviderDTO	descriptors(Map<String,PropertyDescriptorDTO> descriptors)
boolean	equals(Object o)
ParameterProviderDTO	extensionMissing(Boolean extensionMissing)
List<AffectedComponentEntity>	getAffectedComponents()	The set of all components in the flow that are referencing Parameters provided by this provider
String	getAnnotationData()	The annotation data for the parameter provider.
BundleDTO	getBundle()	Get bundle
String	getComments()	The comments of the parameter provider.
String	getCustomUiUrl()	The URL for the custom configuration UI for the parameter provider.
Map<String,PropertyDescriptorDTO>	getDescriptors()	The descriptors for the parameter providers properties.
String	getId()	The id of the component.
String	getName()	The name of the parameter provider.
List<ParameterGroupConfigurationEntity>	getParameterGroupConfigurations()	Configuration for any fetched parameter groups.
List<ParameterStatusDTO>	getParameterStatus()	The status of all provided parameters for this parameter provider
String	getParentGroupId()	The id of parent process group of this component if applicable.
PositionDTO	getPosition()	Get position
Map<String,String>	getProperties()	The properties of the parameter provider.
List<ParameterProviderReferencingComponentEntity>	getReferencingParameterContexts()	The Parameter Contexts that reference this Parameter Provider
String	getType()	The fully qualified type of the parameter provider.
List<String>	getValidationErrors()	Gets the validation errors from the parameter provider.
ParameterProviderDTO.ValidationStatusEnum	getValidationStatus()	Indicates whether the Parameter Provider is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Parameter Provider is valid)
String	getVersionedComponentId()	The ID of the corresponding component that is under version control
int	hashCode()
ParameterProviderDTO	id(String id)
Boolean	isDeprecated()	Whether the parameter provider has been deprecated.
Boolean	isExtensionMissing()	Whether the underlying extension is missing.
Boolean	isMultipleVersionsAvailable()	Whether the parameter provider has multiple versions available.
Boolean	isPersistsState()	Whether the parameter provider persists state.
Boolean	isRestricted()	Whether the parameter provider requires elevated privileges.
ParameterProviderDTO	multipleVersionsAvailable(Boolean multipleVersionsAvailable)
ParameterProviderDTO	name(String name)
ParameterProviderDTO	parameterGroupConfigurations(List<ParameterGroupConfigurationEntity> parameterGroupConfigurations)
ParameterProviderDTO	parameterStatus(List<ParameterStatusDTO> parameterStatus)
ParameterProviderDTO	parentGroupId(String parentGroupId)
ParameterProviderDTO	persistsState(Boolean persistsState)
ParameterProviderDTO	position(PositionDTO position)
ParameterProviderDTO	properties(Map<String,String> properties)
ParameterProviderDTO	putDescriptorsItem(String key, PropertyDescriptorDTO descriptorsItem)
ParameterProviderDTO	putPropertiesItem(String key, String propertiesItem)
ParameterProviderDTO	restricted(Boolean restricted)
void	setAffectedComponents(List<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	setId(String id)
void	setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)
void	setName(String name)
void	setParameterGroupConfigurations(List<ParameterGroupConfigurationEntity> parameterGroupConfigurations)
void	setParameterStatus(List<ParameterStatusDTO> parameterStatus)
void	setParentGroupId(String parentGroupId)
void	setPersistsState(Boolean persistsState)
void	setPosition(PositionDTO position)
void	setProperties(Map<String,String> properties)
void	setRestricted(Boolean restricted)
void	setType(String type)
void	setValidationErrors(List<String> validationErrors)
void	setVersionedComponentId(String versionedComponentId)
private String	toIndentedString(Object o)	Convert the given object to string with each line indented by 4 spaces (except the first line).
String	toString()
ParameterProviderDTO	type(String type)
ParameterProviderDTO	validationErrors(List<String> validationErrors)
ParameterProviderDTO	versionedComponentId(String versionedComponentId)

Methods inherited from class java.lang.Object

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

Field Details

id

private String id

versionedComponentId

private String versionedComponentId

parentGroupId

private String parentGroupId

position

private PositionDTO position

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

multipleVersionsAvailable

private Boolean multipleVersionsAvailable

properties

private Map<String,String> properties

descriptors

private Map<String,PropertyDescriptorDTO> descriptors

parameterGroupConfigurations

private List<ParameterGroupConfigurationEntity> parameterGroupConfigurations

affectedComponents

private List<AffectedComponentEntity> affectedComponents

parameterStatus

private List<ParameterStatusDTO> parameterStatus

referencingParameterContexts

private List<ParameterProviderReferencingComponentEntity> referencingParameterContexts

customUiUrl

private String customUiUrl

annotationData

private String annotationData

validationErrors

private List<String> validationErrors

validationStatus

private ParameterProviderDTO.ValidationStatusEnum validationStatus

extensionMissing

private Boolean extensionMissing

Constructor Details

ParameterProviderDTO

public ParameterProviderDTO()

Method Details

id

public ParameterProviderDTO id(String id)

getId

public String getId()

The id of the component.

Returns:

id

setId

public void setId(String id)

versionedComponentId

public ParameterProviderDTO versionedComponentId(String versionedComponentId)

getVersionedComponentId

public String getVersionedComponentId()

The ID of the corresponding component that is under version control

Returns:

versionedComponentId

setVersionedComponentId

public void setVersionedComponentId(String versionedComponentId)

parentGroupId

public ParameterProviderDTO parentGroupId(String parentGroupId)

getParentGroupId

public String getParentGroupId()

The id of parent process group of this component if applicable.

Returns:

parentGroupId

setParentGroupId

public void setParentGroupId(String parentGroupId)

position

public ParameterProviderDTO position(PositionDTO position)

getPosition

public PositionDTO getPosition()

Get position

Returns:

position

setPosition

public void setPosition(PositionDTO position)

name

public ParameterProviderDTO name(String name)

getName

public String getName()

The name of the parameter provider.

Returns:

name

setName

public void setName(String name)

type

public ParameterProviderDTO type(String type)

getType

public String getType()

The fully qualified type of the parameter provider.

Returns:

type

setType

public void setType(String type)

bundle

public ParameterProviderDTO bundle(BundleDTO bundle)

getBundle

public BundleDTO getBundle()

Get bundle

Returns:

bundle

setBundle

public void setBundle(BundleDTO bundle)

comments

public ParameterProviderDTO comments(String comments)

getComments

public String getComments()

The comments of the parameter provider.

Returns:

comments

setComments

public void setComments(String comments)

persistsState

public ParameterProviderDTO persistsState(Boolean persistsState)

isPersistsState

public Boolean isPersistsState()

Whether the parameter provider persists state.

Returns:

persistsState

setPersistsState

public void setPersistsState(Boolean persistsState)

restricted

public ParameterProviderDTO restricted(Boolean restricted)

isRestricted

public Boolean isRestricted()

Whether the parameter provider requires elevated privileges.

Returns:

restricted

setRestricted

public void setRestricted(Boolean restricted)

deprecated

public ParameterProviderDTO deprecated(Boolean deprecated)

isDeprecated

public Boolean isDeprecated()

Whether the parameter provider has been deprecated.

Returns:

deprecated

setDeprecated

public void setDeprecated(Boolean deprecated)

multipleVersionsAvailable

public ParameterProviderDTO multipleVersionsAvailable(Boolean multipleVersionsAvailable)

isMultipleVersionsAvailable

public Boolean isMultipleVersionsAvailable()

Whether the parameter provider has multiple versions available.

Returns:

multipleVersionsAvailable

setMultipleVersionsAvailable

public void setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)

properties

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

putPropertiesItem

public ParameterProviderDTO putPropertiesItem(String key,
 String propertiesItem)

getProperties

public Map<String,String> getProperties()

The properties of the parameter provider.

Returns:

properties

setProperties

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

descriptors

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

putDescriptorsItem

public ParameterProviderDTO putDescriptorsItem(String key,
 PropertyDescriptorDTO descriptorsItem)

getDescriptors

public Map<String,PropertyDescriptorDTO> getDescriptors()

The descriptors for the parameter providers properties.

Returns:

descriptors

setDescriptors

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

parameterGroupConfigurations

public ParameterProviderDTO parameterGroupConfigurations(List<ParameterGroupConfigurationEntity> parameterGroupConfigurations)

addParameterGroupConfigurationsItem

public ParameterProviderDTO addParameterGroupConfigurationsItem(ParameterGroupConfigurationEntity parameterGroupConfigurationsItem)

getParameterGroupConfigurations

public List<ParameterGroupConfigurationEntity> getParameterGroupConfigurations()

Configuration for any fetched parameter groups.

Returns:

parameterGroupConfigurations

setParameterGroupConfigurations

public void setParameterGroupConfigurations(List<ParameterGroupConfigurationEntity> parameterGroupConfigurations)

affectedComponents

public ParameterProviderDTO affectedComponents(List<AffectedComponentEntity> affectedComponents)

addAffectedComponentsItem

public ParameterProviderDTO addAffectedComponentsItem(AffectedComponentEntity affectedComponentsItem)

getAffectedComponents

public List<AffectedComponentEntity> getAffectedComponents()

The set of all components in the flow that are referencing Parameters provided by this provider

Returns:

affectedComponents

setAffectedComponents

public void setAffectedComponents(List<AffectedComponentEntity> affectedComponents)

parameterStatus

public ParameterProviderDTO parameterStatus(List<ParameterStatusDTO> parameterStatus)

addParameterStatusItem

public ParameterProviderDTO addParameterStatusItem(ParameterStatusDTO parameterStatusItem)

getParameterStatus

public List<ParameterStatusDTO> getParameterStatus()

The status of all provided parameters for this parameter provider

Returns:

parameterStatus

setParameterStatus

public void setParameterStatus(List<ParameterStatusDTO> parameterStatus)

getReferencingParameterContexts

public List<ParameterProviderReferencingComponentEntity> getReferencingParameterContexts()

The Parameter Contexts that reference this Parameter Provider

Returns:

referencingParameterContexts

customUiUrl

public ParameterProviderDTO customUiUrl(String customUiUrl)

getCustomUiUrl

public String getCustomUiUrl()

The URL for the custom configuration UI for the parameter provider.

Returns:

customUiUrl

setCustomUiUrl

public void setCustomUiUrl(String customUiUrl)

annotationData

public ParameterProviderDTO annotationData(String annotationData)

getAnnotationData

public String getAnnotationData()

The annotation data for the parameter provider. This is how the custom UI relays configuration to the parameter provider.

Returns:

annotationData

setAnnotationData

public void setAnnotationData(String annotationData)

validationErrors

public ParameterProviderDTO validationErrors(List<String> validationErrors)

addValidationErrorsItem

public ParameterProviderDTO addValidationErrorsItem(String validationErrorsItem)

getValidationErrors

public List<String> getValidationErrors()

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

Returns:

validationErrors

setValidationErrors

public void setValidationErrors(List<String> validationErrors)

getValidationStatus

public ParameterProviderDTO.ValidationStatusEnum getValidationStatus()

Indicates whether the Parameter Provider is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Parameter Provider is valid)

Returns:

validationStatus

extensionMissing

public ParameterProviderDTO extensionMissing(Boolean extensionMissing)

isExtensionMissing

public Boolean isExtensionMissing()

Whether the underlying extension is missing.

Returns:

extensionMissing

setExtensionMissing

public void setExtensionMissing(Boolean extensionMissing)

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