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

Class ParameterDTO

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

  • Field Details

  • Constructor Details

    • ParameterDTO

      public ParameterDTO()

  • Method Details

    • name

      public ParameterDTO name(String name)

    • getName

      public String getName()
      The name of the Parameter
      Returns:
      name

    • setName

      public void setName(String name)

    • description

      public ParameterDTO description(String description)

    • getDescription

      public String getDescription()
      The description of the Parameter
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • sensitive

      public ParameterDTO sensitive(Boolean sensitive)

    • isSensitive

      public Boolean isSensitive()
      Whether or not the Parameter is sensitive
      Returns:
      sensitive

    • setSensitive

      public void setSensitive(Boolean sensitive)

    • value

      public ParameterDTO value(String value)

    • getValue

      public String getValue()
      The value of the Parameter
      Returns:
      value

    • setValue

      public void setValue(String value)

    • valueRemoved

      public ParameterDTO valueRemoved(Boolean valueRemoved)

    • isValueRemoved

      public Boolean isValueRemoved()
      Whether or not the value of the Parameter was removed. When a request is made to change a parameter, the value may be null. The absence of the value may be used either to indicate that the value is not to be changed, or that the value is to be set to null (i.e., removed). This denotes which of the two scenarios is being encountered.
      Returns:
      valueRemoved

    • setValueRemoved

      public void setValueRemoved(Boolean valueRemoved)

    • provided

      public ParameterDTO provided(Boolean provided)

    • isProvided

      public Boolean isProvided()
      Whether or not the Parameter is provided by a ParameterProvider
      Returns:
      provided

    • setProvided

      public void setProvided(Boolean provided)

    • referencingComponents

      public ParameterDTO referencingComponents(List<AffectedComponentEntity> referencingComponents)

    • addReferencingComponentsItem

      public ParameterDTO addReferencingComponentsItem(AffectedComponentEntity referencingComponentsItem)

    • getReferencingComponents

      public List<AffectedComponentEntity> getReferencingComponents()
      The set of all components in the flow that are referencing this Parameter
      Returns:
      referencingComponents

    • setReferencingComponents

      public void setReferencingComponents(List<AffectedComponentEntity> referencingComponents)

    • parameterContext

      public ParameterDTO parameterContext(ParameterContextReferenceEntity parameterContext)

    • getParameterContext

      public ParameterContextReferenceEntity getParameterContext()
      Get parameterContext
      Returns:
      parameterContext

    • setParameterContext

      public void setParameterContext(ParameterContextReferenceEntity parameterContext)

    • isInherited

      public Boolean isInherited()
      Whether or not the Parameter is inherited from another context
      Returns:
      inherited

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