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

Class ControllerServiceDTO

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

  • Field Details

  • Constructor Details

    • ControllerServiceDTO

      public ControllerServiceDTO()

  • Method Details

    • id

      public ControllerServiceDTO id(String id)

    • getId

      public String getId()
      The id of the component.
      Returns:
      id

    • setId

      public void setId(String id)

    • versionedComponentId

      public ControllerServiceDTO versionedComponentId(String versionedComponentId)

    • getVersionedComponentId

      public String getVersionedComponentId()
      The ID of the corresponding component that is under version control
      Returns:
      versionedComponentId

    • setVersionedComponentId

      public void setVersionedComponentId(String versionedComponentId)

    • parentGroupId

      public ControllerServiceDTO parentGroupId(String parentGroupId)

    • getParentGroupId

      public String getParentGroupId()
      The id of parent process group of this component if applicable.
      Returns:
      parentGroupId

    • setParentGroupId

      public void setParentGroupId(String parentGroupId)

    • position

      public ControllerServiceDTO position(PositionDTO position)

    • getPosition

      public PositionDTO getPosition()
      Get position
      Returns:
      position

    • setPosition

      public void setPosition(PositionDTO position)

    • name

      public ControllerServiceDTO name(String name)

    • getName

      public String getName()
      The name of the controller service.
      Returns:
      name

    • setName

      public void setName(String name)

    • type

      public ControllerServiceDTO type(String type)

    • getType

      public String getType()
      The type of the controller service.
      Returns:
      type

    • setType

      public void setType(String type)

    • bundle

      public ControllerServiceDTO bundle(BundleDTO bundle)

    • getBundle

      public BundleDTO getBundle()
      Get bundle
      Returns:
      bundle

    • setBundle

      public void setBundle(BundleDTO bundle)

    • controllerServiceApis

      public ControllerServiceDTO controllerServiceApis(List<ControllerServiceApiDTO> controllerServiceApis)

    • addControllerServiceApisItem

      public ControllerServiceDTO addControllerServiceApisItem(ControllerServiceApiDTO controllerServiceApisItem)

    • getControllerServiceApis

      public List<ControllerServiceApiDTO> getControllerServiceApis()
      Lists the APIs this Controller Service implements.
      Returns:
      controllerServiceApis

    • setControllerServiceApis

      public void setControllerServiceApis(List<ControllerServiceApiDTO> controllerServiceApis)

    • comments

      public ControllerServiceDTO comments(String comments)

    • getComments

      public String getComments()
      The comments for the controller service.
      Returns:
      comments

    • setComments

      public void setComments(String comments)

    • state

      public ControllerServiceDTO state(ControllerServiceDTO.StateEnum state)

    • getState

      public ControllerServiceDTO.StateEnum getState()
      The state of the controller service.
      Returns:
      state

    • setState

      public void setState(ControllerServiceDTO.StateEnum state)

    • persistsState

      public ControllerServiceDTO persistsState(Boolean persistsState)

    • isPersistsState

      public Boolean isPersistsState()
      Whether the controller service persists state.
      Returns:
      persistsState

    • setPersistsState

      public void setPersistsState(Boolean persistsState)

    • restricted

      public ControllerServiceDTO restricted(Boolean restricted)

    • isRestricted

      public Boolean isRestricted()
      Whether the controller service requires elevated privileges.
      Returns:
      restricted

    • setRestricted

      public void setRestricted(Boolean restricted)

    • deprecated

      public ControllerServiceDTO deprecated(Boolean deprecated)

    • isDeprecated

      public Boolean isDeprecated()
      Whether the ontroller service has been deprecated.
      Returns:
      deprecated

    • setDeprecated

      public void setDeprecated(Boolean deprecated)

    • multipleVersionsAvailable

      public ControllerServiceDTO multipleVersionsAvailable(Boolean multipleVersionsAvailable)

    • isMultipleVersionsAvailable

      public Boolean isMultipleVersionsAvailable()
      Whether the controller service has multiple versions available.
      Returns:
      multipleVersionsAvailable

    • setMultipleVersionsAvailable

      public void setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)

    • supportsSensitiveDynamicProperties

      public ControllerServiceDTO supportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

    • isSupportsSensitiveDynamicProperties

      public Boolean isSupportsSensitiveDynamicProperties()
      Whether the controller service supports sensitive dynamic properties.
      Returns:
      supportsSensitiveDynamicProperties

    • setSupportsSensitiveDynamicProperties

      public void setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

    • properties

      public ControllerServiceDTO properties(Map<String,String> properties)

    • putPropertiesItem

      public ControllerServiceDTO putPropertiesItem(String key, String propertiesItem)

    • getProperties

      public Map<String,String> getProperties()
      The properties of the controller service.
      Returns:
      properties

    • setProperties

      public void setProperties(Map<String,String> properties)

    • descriptors

      public ControllerServiceDTO descriptors(Map<String,PropertyDescriptorDTO> descriptors)

    • putDescriptorsItem

      public ControllerServiceDTO putDescriptorsItem(String key, PropertyDescriptorDTO descriptorsItem)

    • getDescriptors

      public Map<String,PropertyDescriptorDTO> getDescriptors()
      The descriptors for the controller service properties.
      Returns:
      descriptors

    • setDescriptors

      public void setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)

    • sensitiveDynamicPropertyNames

      public ControllerServiceDTO sensitiveDynamicPropertyNames(List<String> sensitiveDynamicPropertyNames)

    • addSensitiveDynamicPropertyNamesItem

      public ControllerServiceDTO addSensitiveDynamicPropertyNamesItem(String sensitiveDynamicPropertyNamesItem)

    • getSensitiveDynamicPropertyNames

      public List<String> getSensitiveDynamicPropertyNames()
      Set of sensitive dynamic property names
      Returns:
      sensitiveDynamicPropertyNames

    • setSensitiveDynamicPropertyNames

      public void setSensitiveDynamicPropertyNames(List<String> sensitiveDynamicPropertyNames)

    • customUiUrl

      public ControllerServiceDTO customUiUrl(String customUiUrl)

    • getCustomUiUrl

      public String getCustomUiUrl()
      The URL for the controller services custom configuration UI if applicable.
      Returns:
      customUiUrl

    • setCustomUiUrl

      public void setCustomUiUrl(String customUiUrl)

    • annotationData

      public ControllerServiceDTO annotationData(String annotationData)

    • getAnnotationData

      public String getAnnotationData()
      The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
      Returns:
      annotationData

    • setAnnotationData

      public void setAnnotationData(String annotationData)

    • referencingComponents

      public ControllerServiceDTO referencingComponents(List<ControllerServiceReferencingComponentEntity> referencingComponents)

    • addReferencingComponentsItem

      public ControllerServiceDTO addReferencingComponentsItem(ControllerServiceReferencingComponentEntity referencingComponentsItem)

    • getReferencingComponents

      public List<ControllerServiceReferencingComponentEntity> getReferencingComponents()
      All components referencing this controller service.
      Returns:
      referencingComponents

    • setReferencingComponents

      public void setReferencingComponents(List<ControllerServiceReferencingComponentEntity> referencingComponents)

    • validationErrors

      public ControllerServiceDTO validationErrors(List<String> validationErrors)

    • addValidationErrorsItem

      public ControllerServiceDTO addValidationErrorsItem(String validationErrorsItem)

    • getValidationErrors

      public List<String> getValidationErrors()
      The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.
      Returns:
      validationErrors

    • setValidationErrors

      public void setValidationErrors(List<String> validationErrors)

    • getValidationStatus

      public ControllerServiceDTO.ValidationStatusEnum getValidationStatus()
      Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)
      Returns:
      validationStatus

    • bulletinLevel

      public ControllerServiceDTO bulletinLevel(String bulletinLevel)

    • getBulletinLevel

      public String getBulletinLevel()
      The level at which the controller service will report bulletins.
      Returns:
      bulletinLevel

    • setBulletinLevel

      public void setBulletinLevel(String bulletinLevel)

    • extensionMissing

      public ControllerServiceDTO extensionMissing(Boolean extensionMissing)

    • isExtensionMissing

      public Boolean isExtensionMissing()
      Whether the underlying extension is missing.
      Returns:
      extensionMissing

    • setExtensionMissing

      public void setExtensionMissing(Boolean extensionMissing)

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