PropertyDescriptorDTO (nifi-client-dto 1.23.2 API)

java.lang.Object
- org.apache.nifi.web.api.dto.PropertyDescriptorDTO

public class PropertyDescriptorDTO
extends Object

A description of a property.

Field Summary

Fields
Modifier and Type	Field and Description
`private List<AllowableValueEntity>`	`allowableValues`
`private String`	`defaultValue`
`private List<PropertyDependencyDTO>`	`dependencies`
`private String`	`description`
`private String`	`displayName`
`private Boolean`	`dynamic`
`private String`	`expressionLanguageScope`
`private String`	`identifiesControllerService`
`private BundleDTO`	`identifiesControllerServiceBundle`
`private String`	`name`
`private Boolean`	`required`
`private Boolean`	`sensitive`
`private Boolean`	`supportsEl`

Constructor Summary

Constructors
Constructor and Description

PropertyDescriptorDTO()

Constructors
Constructor and Description
`PropertyDescriptorDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AllowableValueEntity>`	`getAllowableValues()`
`String`	`getDefaultValue()`
`List<PropertyDependencyDTO>`	`getDependencies()`
`String`	`getDescription()`
`String`	`getDisplayName()`
`String`	`getExpressionLanguageScope()`
`String`	`getIdentifiesControllerService()`
`BundleDTO`	`getIdentifiesControllerServiceBundle()`
`String`	`getName()`
`Boolean`	`getSupportsEl()`
`Boolean`	`isDynamic()`
`Boolean`	`isRequired()`
`Boolean`	`isSensitive()`
`void`	`setAllowableValues(List<AllowableValueEntity> allowableValues)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setDependencies(List<PropertyDependencyDTO> dependencies)`
`void`	`setDescription(String description)`
`void`	`setDisplayName(String displayName)`
`void`	`setDynamic(Boolean dynamic)`
`void`	`setExpressionLanguageScope(String scope)`
`void`	`setIdentifiesControllerService(String identifiesControllerService)`
`void`	`setIdentifiesControllerServiceBundle(BundleDTO identifiesControllerServiceBundle)`
`void`	`setName(String name)`
`void`	`setRequired(Boolean required)`
`void`	`setSensitive(Boolean sensitive)`
`void`	`setSupportsEl(Boolean supportsEl)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name
```
private String name
```

displayName
```
private String displayName
```

description
```
private String description
```

defaultValue
```
private String defaultValue
```

allowableValues

private List<AllowableValueEntity> allowableValues

required
```
private Boolean required
```

sensitive
```
private Boolean sensitive
```

dynamic
```
private Boolean dynamic
```

supportsEl
```
private Boolean supportsEl
```

expressionLanguageScope
```
private String expressionLanguageScope
```

identifiesControllerService

private String identifiesControllerService

identifiesControllerServiceBundle

private BundleDTO identifiesControllerServiceBundle

dependencies

private List<PropertyDependencyDTO> dependencies

Constructor Detail
- PropertyDescriptorDTO
```
public PropertyDescriptorDTO()
```

Method Detail
- getAllowableValues
```
public List<AllowableValueEntity> getAllowableValues()
```
  Returns:
  
  set of allowable values for this property. If empty then the allowable values are not constrained
- setAllowableValues
```
public void setAllowableValues(List<AllowableValueEntity> allowableValues)
```
- getDefaultValue
```
public String getDefaultValue()
```
  Returns:
  
  default value for this property
- setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
- getDescription
```
public String getDescription()
```
  Returns:
  
  An explanation of the meaning of the given property. This description is meant to be displayed to a user or simply provide a mechanism of documenting intent
- setDescription
```
public void setDescription(String description)
```
- getName
```
public String getName()
```
  Returns:
  
  property name
- setName
```
public void setName(String name)
```
- getDisplayName
```
public String getDisplayName()
```
  Returns:
  
  human-readable name to display to users
- setDisplayName
```
public void setDisplayName(String displayName)
```
- isRequired
```
public Boolean isRequired()
```
  Returns:
  
  whether the property is required for this processor
- setRequired
```
public void setRequired(Boolean required)
```
- isSensitive
```
public Boolean isSensitive()
```
  Returns:
  
  indicates that the value for this property should be considered sensitive and protected whenever stored or represented
- setSensitive
```
public void setSensitive(Boolean sensitive)
```
- isDynamic
```
public Boolean isDynamic()
```
  Returns:
  
  indicates whether this property is dynamic
- setDynamic
```
public void setDynamic(Boolean dynamic)
```
- getSupportsEl
```
public Boolean getSupportsEl()
```
  Returns:
  
  specifies whether or not this property support expression language
- setSupportsEl
```
public void setSupportsEl(Boolean supportsEl)
```
- getExpressionLanguageScope
```
public String getExpressionLanguageScope()
```
  Returns:
  
  specifies the scope of expression language evaluation
- setExpressionLanguageScope
```
public void setExpressionLanguageScope(String scope)
```
- getIdentifiesControllerService
```
public String getIdentifiesControllerService()
```
  Returns:
  
  if this property identifies a controller service this returns the fully qualified type, null otherwise
- setIdentifiesControllerService
```
public void setIdentifiesControllerService(String identifiesControllerService)
```
- getIdentifiesControllerServiceBundle
```
public BundleDTO getIdentifiesControllerServiceBundle()
```
  Returns:
  
  if this property identifies a controller service this returns the bundle of the type, null otherwise
- setIdentifiesControllerServiceBundle
```
public void setIdentifiesControllerServiceBundle(BundleDTO identifiesControllerServiceBundle)
```
- getDependencies
```
public List<PropertyDependencyDTO> getDependencies()
```
- setDependencies
```
public void setDependencies(List<PropertyDependencyDTO> dependencies)
```

Class PropertyDescriptorDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

displayName

description

defaultValue

allowableValues

required

sensitive

dynamic

supportsEl

expressionLanguageScope

identifiesControllerService

identifiesControllerServiceBundle

dependencies

Constructor Detail

PropertyDescriptorDTO

Method Detail

getAllowableValues

setAllowableValues

getDefaultValue

setDefaultValue

getDescription

setDescription

getName

setName

getDisplayName

setDisplayName

isRequired

setRequired

isSensitive

setSensitive

isDynamic

setDynamic

getSupportsEl

setSupportsEl

getExpressionLanguageScope

setExpressionLanguageScope

getIdentifiesControllerService

setIdentifiesControllerService

getIdentifiesControllerServiceBundle

setIdentifiesControllerServiceBundle

getDependencies

setDependencies