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

Class ControllerServiceDefinition

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

  • Field Details

    • group

      private String group

    • artifact

      private String artifact

    • version

      private String version

    • type

      private String type

    • typeDescription

      private String typeDescription

    • buildInfo

      private BuildInfo buildInfo

    • providedApiImplementations

      private List<DefinedType> providedApiImplementations

    • tags

      private List<String> tags

    • seeAlso

      private List<String> seeAlso

    • deprecated

      private Boolean deprecated

    • deprecationReason

      private String deprecationReason

    • deprecationAlternatives

      private List<String> deprecationAlternatives

    • restricted

      private Boolean restricted

    • restrictedExplanation

      private String restrictedExplanation

    • explicitRestrictions

      private List<Restriction> explicitRestrictions

    • stateful

      private Stateful stateful

    • systemResourceConsiderations

      private List<SystemResourceConsideration> systemResourceConsiderations

    • additionalDetails

      private Boolean additionalDetails

    • propertyDescriptors

      private Map<String,PropertyDescriptor> propertyDescriptors

    • supportsDynamicProperties

      private Boolean supportsDynamicProperties

    • supportsSensitiveDynamicProperties

      private Boolean supportsSensitiveDynamicProperties

    • dynamicProperties

      private List<DynamicProperty> dynamicProperties

  • Constructor Details

    • ControllerServiceDefinition

      public ControllerServiceDefinition()

  • Method Details

    • group

      public ControllerServiceDefinition group(String group)

    • getGroup

      public String getGroup()
      The group name of the bundle that provides the referenced type.
      Returns:
      group

    • setGroup

      public void setGroup(String group)

    • artifact

      public ControllerServiceDefinition artifact(String artifact)

    • getArtifact

      public String getArtifact()
      The artifact name of the bundle that provides the referenced type.
      Returns:
      artifact

    • setArtifact

      public void setArtifact(String artifact)

    • version

      public ControllerServiceDefinition version(String version)

    • getVersion

      public String getVersion()
      The version of the bundle that provides the referenced type.
      Returns:
      version

    • setVersion

      public void setVersion(String version)

    • type

      public ControllerServiceDefinition type(String type)

    • getType

      public String getType()
      The fully-qualified class type
      Returns:
      type

    • setType

      public void setType(String type)

    • typeDescription

      public ControllerServiceDefinition typeDescription(String typeDescription)

    • getTypeDescription

      public String getTypeDescription()
      The description of the type.
      Returns:
      typeDescription

    • setTypeDescription

      public void setTypeDescription(String typeDescription)

    • buildInfo

      public ControllerServiceDefinition buildInfo(BuildInfo buildInfo)

    • getBuildInfo

      public BuildInfo getBuildInfo()
      Get buildInfo
      Returns:
      buildInfo

    • setBuildInfo

      public void setBuildInfo(BuildInfo buildInfo)

    • providedApiImplementations

      public ControllerServiceDefinition providedApiImplementations(List<DefinedType> providedApiImplementations)

    • addProvidedApiImplementationsItem

      public ControllerServiceDefinition addProvidedApiImplementationsItem(DefinedType providedApiImplementationsItem)

    • getProvidedApiImplementations

      public List<DefinedType> getProvidedApiImplementations()
      If this type represents a provider for an interface, this lists the APIs it implements
      Returns:
      providedApiImplementations

    • setProvidedApiImplementations

      public void setProvidedApiImplementations(List<DefinedType> providedApiImplementations)

    • tags

      public ControllerServiceDefinition tags(List<String> tags)

    • addTagsItem

      public ControllerServiceDefinition addTagsItem(String tagsItem)

    • getTags

      public List<String> getTags()
      The tags associated with this type
      Returns:
      tags

    • setTags

      public void setTags(List<String> tags)

    • seeAlso

      public ControllerServiceDefinition seeAlso(List<String> seeAlso)

    • addSeeAlsoItem

      public ControllerServiceDefinition addSeeAlsoItem(String seeAlsoItem)

    • getSeeAlso

      public List<String> getSeeAlso()
      The names of other component types that may be related
      Returns:
      seeAlso

    • setSeeAlso

      public void setSeeAlso(List<String> seeAlso)

    • deprecated

      public ControllerServiceDefinition deprecated(Boolean deprecated)

    • isDeprecated

      public Boolean isDeprecated()
      Whether or not the component has been deprecated
      Returns:
      deprecated

    • setDeprecated

      public void setDeprecated(Boolean deprecated)

    • deprecationReason

      public ControllerServiceDefinition deprecationReason(String deprecationReason)

    • getDeprecationReason

      public String getDeprecationReason()
      If this component has been deprecated, this optional field can be used to provide an explanation
      Returns:
      deprecationReason

    • setDeprecationReason

      public void setDeprecationReason(String deprecationReason)

    • deprecationAlternatives

      public ControllerServiceDefinition deprecationAlternatives(List<String> deprecationAlternatives)

    • addDeprecationAlternativesItem

      public ControllerServiceDefinition addDeprecationAlternativesItem(String deprecationAlternativesItem)

    • getDeprecationAlternatives

      public List<String> getDeprecationAlternatives()
      If this component has been deprecated, this optional field provides alternatives to use
      Returns:
      deprecationAlternatives

    • setDeprecationAlternatives

      public void setDeprecationAlternatives(List<String> deprecationAlternatives)

    • restricted

      public ControllerServiceDefinition restricted(Boolean restricted)

    • isRestricted

      public Boolean isRestricted()
      Whether or not the component has a general restriction
      Returns:
      restricted

    • setRestricted

      public void setRestricted(Boolean restricted)

    • restrictedExplanation

      public ControllerServiceDefinition restrictedExplanation(String restrictedExplanation)

    • getRestrictedExplanation

      public String getRestrictedExplanation()
      An optional description of the general restriction
      Returns:
      restrictedExplanation

    • setRestrictedExplanation

      public void setRestrictedExplanation(String restrictedExplanation)

    • explicitRestrictions

      public ControllerServiceDefinition explicitRestrictions(List<Restriction> explicitRestrictions)

    • addExplicitRestrictionsItem

      public ControllerServiceDefinition addExplicitRestrictionsItem(Restriction explicitRestrictionsItem)

    • getExplicitRestrictions

      public List<Restriction> getExplicitRestrictions()
      Explicit restrictions that indicate a require permission to use the component
      Returns:
      explicitRestrictions

    • setExplicitRestrictions

      public void setExplicitRestrictions(List<Restriction> explicitRestrictions)

    • stateful

      public ControllerServiceDefinition stateful(Stateful stateful)

    • getStateful

      public Stateful getStateful()
      Get stateful
      Returns:
      stateful

    • setStateful

      public void setStateful(Stateful stateful)

    • systemResourceConsiderations

      public ControllerServiceDefinition systemResourceConsiderations(List<SystemResourceConsideration> systemResourceConsiderations)

    • addSystemResourceConsiderationsItem

      public ControllerServiceDefinition addSystemResourceConsiderationsItem(SystemResourceConsideration systemResourceConsiderationsItem)

    • getSystemResourceConsiderations

      public List<SystemResourceConsideration> getSystemResourceConsiderations()
      The system resource considerations for the given component
      Returns:
      systemResourceConsiderations

    • setSystemResourceConsiderations

      public void setSystemResourceConsiderations(List<SystemResourceConsideration> systemResourceConsiderations)

    • additionalDetails

      public ControllerServiceDefinition additionalDetails(Boolean additionalDetails)

    • isAdditionalDetails

      public Boolean isAdditionalDetails()
      Indicates if the component has additional details documentation
      Returns:
      additionalDetails

    • setAdditionalDetails

      public void setAdditionalDetails(Boolean additionalDetails)

    • propertyDescriptors

      public ControllerServiceDefinition propertyDescriptors(Map<String,PropertyDescriptor> propertyDescriptors)

    • putPropertyDescriptorsItem

      public ControllerServiceDefinition putPropertyDescriptorsItem(String key, PropertyDescriptor propertyDescriptorsItem)

    • getPropertyDescriptors

      public Map<String,PropertyDescriptor> getPropertyDescriptors()
      Descriptions of configuration properties applicable to this component.
      Returns:
      propertyDescriptors

    • setPropertyDescriptors

      public void setPropertyDescriptors(Map<String,PropertyDescriptor> propertyDescriptors)

    • supportsDynamicProperties

      public ControllerServiceDefinition supportsDynamicProperties(Boolean supportsDynamicProperties)

    • isSupportsDynamicProperties

      public Boolean isSupportsDynamicProperties()
      Whether or not this component makes use of dynamic (user-set) properties.
      Returns:
      supportsDynamicProperties

    • setSupportsDynamicProperties

      public void setSupportsDynamicProperties(Boolean supportsDynamicProperties)

    • supportsSensitiveDynamicProperties

      public ControllerServiceDefinition supportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

    • isSupportsSensitiveDynamicProperties

      public Boolean isSupportsSensitiveDynamicProperties()
      Whether or not this component makes use of sensitive dynamic (user-set) properties.
      Returns:
      supportsSensitiveDynamicProperties

    • setSupportsSensitiveDynamicProperties

      public void setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

    • dynamicProperties

      public ControllerServiceDefinition dynamicProperties(List<DynamicProperty> dynamicProperties)

    • addDynamicPropertiesItem

      public ControllerServiceDefinition addDynamicPropertiesItem(DynamicProperty dynamicPropertiesItem)

    • getDynamicProperties

      public List<DynamicProperty> getDynamicProperties()
      Describes the dynamic properties supported by this component
      Returns:
      dynamicProperties

    • setDynamicProperties

      public void setDynamicProperties(List<DynamicProperty> dynamicProperties)

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