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

Class PropertyDescriptor

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

  • Field Details

  • Constructor Details

    • PropertyDescriptor

      public PropertyDescriptor()

  • Method Details

    • name

      public PropertyDescriptor name(String name)

    • getName

      public String getName()
      The name of the property key
      Returns:
      name

    • setName

      public void setName(String name)

    • displayName

      public PropertyDescriptor displayName(String displayName)

    • getDisplayName

      public String getDisplayName()
      The display name of the property key, if different from the name
      Returns:
      displayName

    • setDisplayName

      public void setDisplayName(String displayName)

    • description

      public PropertyDescriptor description(String description)

    • getDescription

      public String getDescription()
      The description of what the property does
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • allowableValues

      public PropertyDescriptor allowableValues(List<PropertyAllowableValue> allowableValues)

    • addAllowableValuesItem

      public PropertyDescriptor addAllowableValuesItem(PropertyAllowableValue allowableValuesItem)

    • getAllowableValues

      public List<PropertyAllowableValue> getAllowableValues()
      A list of the allowable values for the property
      Returns:
      allowableValues

    • setAllowableValues

      public void setAllowableValues(List<PropertyAllowableValue> allowableValues)

    • defaultValue

      public PropertyDescriptor defaultValue(String defaultValue)

    • getDefaultValue

      public String getDefaultValue()
      The default value if a user-set value is not specified
      Returns:
      defaultValue

    • setDefaultValue

      public void setDefaultValue(String defaultValue)

    • required

      public PropertyDescriptor required(Boolean required)

    • isRequired

      public Boolean isRequired()
      Whether or not the property is required for the component
      Returns:
      required

    • setRequired

      public void setRequired(Boolean required)

    • sensitive

      public PropertyDescriptor sensitive(Boolean sensitive)

    • isSensitive

      public Boolean isSensitive()
      Whether or not the value of the property is considered sensitive (e.g., passwords and keys)
      Returns:
      sensitive

    • setSensitive

      public void setSensitive(Boolean sensitive)

    • expressionLanguageScope

      public PropertyDescriptor expressionLanguageScope(PropertyDescriptor.ExpressionLanguageScopeEnum expressionLanguageScope)

    • getExpressionLanguageScope

      public PropertyDescriptor.ExpressionLanguageScopeEnum getExpressionLanguageScope()
      The scope of expression language supported by this property
      Returns:
      expressionLanguageScope

    • setExpressionLanguageScope

      public void setExpressionLanguageScope(PropertyDescriptor.ExpressionLanguageScopeEnum expressionLanguageScope)

    • getExpressionLanguageScopeDescription

      public String getExpressionLanguageScopeDescription()
      The description of the expression language scope supported by this property
      Returns:
      expressionLanguageScopeDescription

    • typeProvidedByValue

      public PropertyDescriptor typeProvidedByValue(DefinedType typeProvidedByValue)

    • getTypeProvidedByValue

      public DefinedType getTypeProvidedByValue()
      Get typeProvidedByValue
      Returns:
      typeProvidedByValue

    • setTypeProvidedByValue

      public void setTypeProvidedByValue(DefinedType typeProvidedByValue)

    • validRegex

      public PropertyDescriptor validRegex(String validRegex)

    • getValidRegex

      public String getValidRegex()
      A regular expression that can be used to validate the value of this property
      Returns:
      validRegex

    • setValidRegex

      public void setValidRegex(String validRegex)

    • validator

      public PropertyDescriptor validator(String validator)

    • getValidator

      public String getValidator()
      Name of the validator used for this property descriptor
      Returns:
      validator

    • setValidator

      public void setValidator(String validator)

    • dynamic

      public PropertyDescriptor dynamic(Boolean dynamic)

    • isDynamic

      public Boolean isDynamic()
      Whether or not the descriptor is for a dynamically added property
      Returns:
      dynamic

    • setDynamic

      public void setDynamic(Boolean dynamic)

    • resourceDefinition

      public PropertyDescriptor resourceDefinition(PropertyResourceDefinition resourceDefinition)

    • getResourceDefinition

      public PropertyResourceDefinition getResourceDefinition()
      Get resourceDefinition
      Returns:
      resourceDefinition

    • setResourceDefinition

      public void setResourceDefinition(PropertyResourceDefinition resourceDefinition)

    • dependencies

      public PropertyDescriptor dependencies(List<PropertyDependency> dependencies)

    • addDependenciesItem

      public PropertyDescriptor addDependenciesItem(PropertyDependency dependenciesItem)

    • getDependencies

      public List<PropertyDependency> getDependencies()
      The dependencies that this property has on other properties
      Returns:
      dependencies

    • setDependencies

      public void setDependencies(List<PropertyDependency> 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).