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

Class PropertyDescriptorDTO

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

  • Field Details

    • 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 Details

    • PropertyDescriptorDTO

      public PropertyDescriptorDTO()

  • Method Details

    • name

      public PropertyDescriptorDTO name(String name)

    • getName

      public String getName()
      The name for the property.
      Returns:
      name

    • setName

      public void setName(String name)

    • displayName

      public PropertyDescriptorDTO displayName(String displayName)

    • getDisplayName

      public String getDisplayName()
      The human readable name for the property.
      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(String displayName)

    • description

      public PropertyDescriptorDTO description(String description)

    • getDescription

      public String getDescription()
      The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent.
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • defaultValue

      public PropertyDescriptorDTO defaultValue(String defaultValue)

    • getDefaultValue

      public String getDefaultValue()
      The default value for the property.
      Returns:
      defaultValue

    • setDefaultValue

      public void setDefaultValue(String defaultValue)

    • allowableValues

      public PropertyDescriptorDTO allowableValues(List<AllowableValueEntity> allowableValues)

    • addAllowableValuesItem

      public PropertyDescriptorDTO addAllowableValuesItem(AllowableValueEntity allowableValuesItem)

    • getAllowableValues

      public List<AllowableValueEntity> getAllowableValues()
      Allowable values for the property. If empty then the allowed values are not constrained.
      Returns:
      allowableValues

    • setAllowableValues

      public void setAllowableValues(List<AllowableValueEntity> allowableValues)

    • required

      public PropertyDescriptorDTO required(Boolean required)

    • isRequired

      public Boolean isRequired()
      Whether the property is required.
      Returns:
      required

    • setRequired

      public void setRequired(Boolean required)

    • sensitive

      public PropertyDescriptorDTO sensitive(Boolean sensitive)

    • isSensitive

      public Boolean isSensitive()
      Whether the property is sensitive and protected whenever stored or represented.
      Returns:
      sensitive

    • setSensitive

      public void setSensitive(Boolean sensitive)

    • dynamic

      public PropertyDescriptorDTO dynamic(Boolean dynamic)

    • isDynamic

      public Boolean isDynamic()
      Whether the property is dynamic (user-defined).
      Returns:
      dynamic

    • setDynamic

      public void setDynamic(Boolean dynamic)

    • supportsEl

      public PropertyDescriptorDTO supportsEl(Boolean supportsEl)

    • isSupportsEl

      public Boolean isSupportsEl()
      Whether the property supports expression language.
      Returns:
      supportsEl

    • setSupportsEl

      public void setSupportsEl(Boolean supportsEl)

    • expressionLanguageScope

      public PropertyDescriptorDTO expressionLanguageScope(String expressionLanguageScope)

    • getExpressionLanguageScope

      public String getExpressionLanguageScope()
      Scope of the Expression Language evaluation for the property.
      Returns:
      expressionLanguageScope

    • setExpressionLanguageScope

      public void setExpressionLanguageScope(String expressionLanguageScope)

    • identifiesControllerService

      public PropertyDescriptorDTO identifiesControllerService(String identifiesControllerService)

    • getIdentifiesControllerService

      public String getIdentifiesControllerService()
      If the property identifies a controller service this returns the fully qualified type.
      Returns:
      identifiesControllerService

    • setIdentifiesControllerService

      public void setIdentifiesControllerService(String identifiesControllerService)

    • identifiesControllerServiceBundle

      public PropertyDescriptorDTO identifiesControllerServiceBundle(BundleDTO identifiesControllerServiceBundle)

    • getIdentifiesControllerServiceBundle

      public BundleDTO getIdentifiesControllerServiceBundle()
      Get identifiesControllerServiceBundle
      Returns:
      identifiesControllerServiceBundle

    • setIdentifiesControllerServiceBundle

      public void setIdentifiesControllerServiceBundle(BundleDTO identifiesControllerServiceBundle)

    • dependencies

      public PropertyDescriptorDTO dependencies(List<PropertyDependencyDTO> dependencies)

    • addDependenciesItem

      public PropertyDescriptorDTO addDependenciesItem(PropertyDependencyDTO dependenciesItem)

    • getDependencies

      public List<PropertyDependencyDTO> getDependencies()
      A list of dependencies that must be met in order for this Property to be relevant. If any of these dependencies is not met, the property described by this Property Descriptor is not relevant.
      Returns:
      dependencies

    • setDependencies

      public void setDependencies(List<PropertyDependencyDTO> dependencies)

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