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

Class ReportingTaskDTO

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

  • Field Details

  • Constructor Details

    • ReportingTaskDTO

      public ReportingTaskDTO()

  • Method Details

    • id

      public ReportingTaskDTO id(String id)

    • getId

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

    • setId

      public void setId(String id)

    • versionedComponentId

      public ReportingTaskDTO 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 ReportingTaskDTO 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 ReportingTaskDTO position(PositionDTO position)

    • getPosition

      public PositionDTO getPosition()
      Get position
      Returns:
      position

    • setPosition

      public void setPosition(PositionDTO position)

    • name

      public ReportingTaskDTO name(String name)

    • getName

      public String getName()
      The name of the reporting task.
      Returns:
      name

    • setName

      public void setName(String name)

    • type

      public ReportingTaskDTO type(String type)

    • getType

      public String getType()
      The fully qualified type of the reporting task.
      Returns:
      type

    • setType

      public void setType(String type)

    • bundle

      public ReportingTaskDTO bundle(BundleDTO bundle)

    • getBundle

      public BundleDTO getBundle()
      Get bundle
      Returns:
      bundle

    • setBundle

      public void setBundle(BundleDTO bundle)

    • state

      public ReportingTaskDTO state(ReportingTaskDTO.StateEnum state)

    • getState

      public ReportingTaskDTO.StateEnum getState()
      The state of the reporting task.
      Returns:
      state

    • setState

      public void setState(ReportingTaskDTO.StateEnum state)

    • comments

      public ReportingTaskDTO comments(String comments)

    • getComments

      public String getComments()
      The comments of the reporting task.
      Returns:
      comments

    • setComments

      public void setComments(String comments)

    • persistsState

      public ReportingTaskDTO persistsState(Boolean persistsState)

    • isPersistsState

      public Boolean isPersistsState()
      Whether the reporting task persists state.
      Returns:
      persistsState

    • setPersistsState

      public void setPersistsState(Boolean persistsState)

    • restricted

      public ReportingTaskDTO restricted(Boolean restricted)

    • isRestricted

      public Boolean isRestricted()
      Whether the reporting task requires elevated privileges.
      Returns:
      restricted

    • setRestricted

      public void setRestricted(Boolean restricted)

    • deprecated

      public ReportingTaskDTO deprecated(Boolean deprecated)

    • isDeprecated

      public Boolean isDeprecated()
      Whether the reporting task has been deprecated.
      Returns:
      deprecated

    • setDeprecated

      public void setDeprecated(Boolean deprecated)

    • multipleVersionsAvailable

      public ReportingTaskDTO multipleVersionsAvailable(Boolean multipleVersionsAvailable)

    • isMultipleVersionsAvailable

      public Boolean isMultipleVersionsAvailable()
      Whether the reporting task has multiple versions available.
      Returns:
      multipleVersionsAvailable

    • setMultipleVersionsAvailable

      public void setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)

    • supportsSensitiveDynamicProperties

      public ReportingTaskDTO supportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

    • isSupportsSensitiveDynamicProperties

      public Boolean isSupportsSensitiveDynamicProperties()
      Whether the reporting task supports sensitive dynamic properties.
      Returns:
      supportsSensitiveDynamicProperties

    • setSupportsSensitiveDynamicProperties

      public void setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)

    • schedulingPeriod

      public ReportingTaskDTO schedulingPeriod(String schedulingPeriod)

    • getSchedulingPeriod

      public String getSchedulingPeriod()
      The frequency with which to schedule the reporting task. The format of the value will depend on the value of the schedulingStrategy.
      Returns:
      schedulingPeriod

    • setSchedulingPeriod

      public void setSchedulingPeriod(String schedulingPeriod)

    • schedulingStrategy

      public ReportingTaskDTO schedulingStrategy(String schedulingStrategy)

    • getSchedulingStrategy

      public String getSchedulingStrategy()
      The scheduling strategy that determines how the schedulingPeriod value should be interpreted.
      Returns:
      schedulingStrategy

    • setSchedulingStrategy

      public void setSchedulingStrategy(String schedulingStrategy)

    • defaultSchedulingPeriod

      public ReportingTaskDTO defaultSchedulingPeriod(Map<String,String> defaultSchedulingPeriod)

    • putDefaultSchedulingPeriodItem

      public ReportingTaskDTO putDefaultSchedulingPeriodItem(String key, String defaultSchedulingPeriodItem)

    • getDefaultSchedulingPeriod

      public Map<String,String> getDefaultSchedulingPeriod()
      The default scheduling period for the different scheduling strategies.
      Returns:
      defaultSchedulingPeriod

    • setDefaultSchedulingPeriod

      public void setDefaultSchedulingPeriod(Map<String,String> defaultSchedulingPeriod)

    • properties

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

    • putPropertiesItem

      public ReportingTaskDTO putPropertiesItem(String key, String propertiesItem)

    • getProperties

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

    • setProperties

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

    • descriptors

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

    • putDescriptorsItem

      public ReportingTaskDTO putDescriptorsItem(String key, PropertyDescriptorDTO descriptorsItem)

    • getDescriptors

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

    • setDescriptors

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

    • sensitiveDynamicPropertyNames

      public ReportingTaskDTO sensitiveDynamicPropertyNames(List<String> sensitiveDynamicPropertyNames)

    • addSensitiveDynamicPropertyNamesItem

      public ReportingTaskDTO 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 ReportingTaskDTO customUiUrl(String customUiUrl)

    • getCustomUiUrl

      public String getCustomUiUrl()
      The URL for the custom configuration UI for the reporting task.
      Returns:
      customUiUrl

    • setCustomUiUrl

      public void setCustomUiUrl(String customUiUrl)

    • annotationData

      public ReportingTaskDTO annotationData(String annotationData)

    • getAnnotationData

      public String getAnnotationData()
      The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task.
      Returns:
      annotationData

    • setAnnotationData

      public void setAnnotationData(String annotationData)

    • validationErrors

      public ReportingTaskDTO validationErrors(List<String> validationErrors)

    • addValidationErrorsItem

      public ReportingTaskDTO addValidationErrorsItem(String validationErrorsItem)

    • getValidationErrors

      public List<String> getValidationErrors()
      Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.
      Returns:
      validationErrors

    • setValidationErrors

      public void setValidationErrors(List<String> validationErrors)

    • getValidationStatus

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

    • activeThreadCount

      public ReportingTaskDTO activeThreadCount(Integer activeThreadCount)

    • getActiveThreadCount

      public Integer getActiveThreadCount()
      The number of active threads for the reporting task.
      Returns:
      activeThreadCount

    • setActiveThreadCount

      public void setActiveThreadCount(Integer activeThreadCount)

    • extensionMissing

      public ReportingTaskDTO 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).