ReportingTaskDTO (nifi-client-dto 1.19.1 API)

java.lang.Object
- org.apache.nifi.web.api.dto.ComponentDTO
- - org.apache.nifi.web.api.dto.ReportingTaskDTO

```
public class ReportingTaskDTO
extends ComponentDTO
```
Component that is capable of reporting internal NiFi state to an external service

Field Summary

Fields
Modifier and Type	Field and Description
`private Integer`	`activeThreadCount`
`private String`	`annotationData`
`private BundleDTO`	`bundle`
`private String`	`comments`
`private String`	`customUiUrl`
`private Map<String,String>`	`defaultSchedulingPeriod`
`private Boolean`	`deprecated`
`private Map<String,PropertyDescriptorDTO>`	`descriptors`
`static String`	`INVALID`
`private Boolean`	`isExtensionMissing`
`private Boolean`	`multipleVersionsAvailable`
`private String`	`name`
`private Boolean`	`persistsState`
`private Map<String,String>`	`properties`
`private Boolean`	`restricted`
`private String`	`schedulingPeriod`
`private String`	`schedulingStrategy`
`private Set<String>`	`sensitiveDynamicPropertyNames`
`private String`	`state`
`private Boolean`	`supportsSensitiveDynamicProperties`
`private String`	`type`
`static String`	`VALID`
`static String`	`VALIDATING`
`private Collection<String>`	`validationErrors`
`private String`	`validationStatus`

Constructor Summary

Constructors
Constructor and Description

ReportingTaskDTO()

Constructors
Constructor and Description
`ReportingTaskDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getActiveThreadCount()`
`String`	`getAnnotationData()`
`BundleDTO`	`getBundle()` The details of the artifact that bundled this reporting task type.
`String`	`getComments()`
`String`	`getCustomUiUrl()`
`Map<String,String>`	`getDefaultSchedulingPeriod()`
`Boolean`	`getDeprecated()`
`Map<String,PropertyDescriptorDTO>`	`getDescriptors()`
`Boolean`	`getExtensionMissing()`
`Boolean`	`getMultipleVersionsAvailable()`
`String`	`getName()`
`Boolean`	`getPersistsState()`
`Map<String,String>`	`getProperties()`
`Boolean`	`getRestricted()`
`String`	`getSchedulingPeriod()` The frequency with which to schedule the reporting task.
`String`	`getSchedulingStrategy()`
`Set<String>`	`getSensitiveDynamicPropertyNames()`
`String`	`getState()`
`Boolean`	`getSupportsSensitiveDynamicProperties()`
`String`	`getType()`
`Collection<String>`	`getValidationErrors()` Gets the validation errors from this reporting task.
`String`	`getValidationStatus()`
`void`	`setActiveThreadCount(Integer activeThreadCount)`
`void`	`setAnnotationData(String annotationData)`
`void`	`setBundle(BundleDTO bundle)`
`void`	`setComments(String comments)`
`void`	`setCustomUiUrl(String customUiUrl)`
`void`	`setDefaultSchedulingPeriod(Map<String,String> defaultSchedulingPeriod)`
`void`	`setDeprecated(Boolean deprecated)`
`void`	`setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)`
`void`	`setExtensionMissing(Boolean extensionMissing)`
`void`	`setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)`
`void`	`setName(String name)`
`void`	`setPersistsState(Boolean persistsState)`
`void`	`setProperties(Map<String,String> properties)`
`void`	`setRestricted(Boolean restricted)`
`void`	`setSchedulingPeriod(String schedulingPeriod)`
`void`	`setSchedulingStrategy(String schedulingStrategy)`
`void`	`setSensitiveDynamicPropertyNames(Set<String> sensitiveDynamicPropertyNames)`
`void`	`setState(String state)`
`void`	`setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)`
`void`	`setType(String type)`
`void`	`setValidationErrors(Collection<String> validationErrors)`
`void`	`setValidationStatus(String validationStatus)`

Methods inherited from class org.apache.nifi.web.api.dto.ComponentDTO
equals, getId, getParentGroupId, getPosition, getVersionedComponentId, hashCode, setId, setParentGroupId, setPosition, setVersionedComponentId, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

VALID
```
public static final String VALID
```
See Also:

Constant Field Values

INVALID
```
public static final String INVALID
```
See Also:

Constant Field Values

VALIDATING
```
public static final String VALIDATING
```
See Also:

Constant Field Values

name
```
private String name
```

type
```
private String type
```

bundle
```
private BundleDTO bundle
```

state
```
private String state
```

comments
```
private String comments
```

persistsState
```
private Boolean persistsState
```

restricted
```
private Boolean restricted
```

deprecated
```
private Boolean deprecated
```

isExtensionMissing
```
private Boolean isExtensionMissing
```

multipleVersionsAvailable

private Boolean multipleVersionsAvailable

supportsSensitiveDynamicProperties

private Boolean supportsSensitiveDynamicProperties

schedulingPeriod
```
private String schedulingPeriod
```

schedulingStrategy
```
private String schedulingStrategy
```

defaultSchedulingPeriod

private Map<String,String> defaultSchedulingPeriod

properties
```
private Map<String,String> properties
```

descriptors

private Map<String,PropertyDescriptorDTO> descriptors

sensitiveDynamicPropertyNames

private Set<String> sensitiveDynamicPropertyNames

customUiUrl
```
private String customUiUrl
```

annotationData
```
private String annotationData
```

validationErrors

private Collection<String> validationErrors

validationStatus
```
private String validationStatus
```

activeThreadCount
```
private Integer activeThreadCount
```

Constructor Detail
- ReportingTaskDTO
```
public ReportingTaskDTO()
```

Method Detail
- getName
```
public String getName()
```
  Returns:
  
  user-defined name of the reporting task
- setName
```
public void setName(String name)
```
- getComments
```
public String getComments()
```
  Returns:
  
  user-defined comments for the reporting task
- setComments
```
public void setComments(String comments)
```
- getType
```
public String getType()
```
  Returns:
  
  type of reporting task
- setType
```
public void setType(String type)
```
- getBundle
```
public BundleDTO getBundle()
```
  The details of the artifact that bundled this reporting task type.
  
  Returns:
  
  The bundle details
- setBundle
```
public void setBundle(BundleDTO bundle)
```
- getSchedulingPeriod
```
public String getSchedulingPeriod()
```
  The frequency with which to schedule the reporting task. The format of the value will depend on the value of getSchedulingStrategy().
  
  Returns:
  
  The scheduling period
- setSchedulingPeriod
```
public void setSchedulingPeriod(String schedulingPeriod)
```
- getPersistsState
```
public Boolean getPersistsState()
```
  Returns:
  
  whether this reporting task persists state
- setPersistsState
```
public void setPersistsState(Boolean persistsState)
```
- getRestricted
```
public Boolean getRestricted()
```
  Returns:
  
  whether this reporting task requires elevated privileges
- setRestricted
```
public void setRestricted(Boolean restricted)
```
- getDeprecated
```
public Boolean getDeprecated()
```
  Returns:
  
  Whether the reporting task has been deprecated.
- setDeprecated
```
public void setDeprecated(Boolean deprecated)
```
- getExtensionMissing
```
public Boolean getExtensionMissing()
```
  Returns:
  
  whether the underlying extension is missing
- setExtensionMissing
```
public void setExtensionMissing(Boolean extensionMissing)
```
- getMultipleVersionsAvailable
```
public Boolean getMultipleVersionsAvailable()
```
  Returns:
  
  whether this reporting task has multiple versions available
- setMultipleVersionsAvailable
```
public void setMultipleVersionsAvailable(Boolean multipleVersionsAvailable)
```
- getSupportsSensitiveDynamicProperties
```
public Boolean getSupportsSensitiveDynamicProperties()
```
  Returns:
  
  whether this reporting task supports sensitive dynamic properties
- setSupportsSensitiveDynamicProperties
```
public void setSupportsSensitiveDynamicProperties(Boolean supportsSensitiveDynamicProperties)
```
- getState
```
public String getState()
```
  Returns:
  
  current scheduling state of the reporting task
- setState
```
public void setState(String state)
```
- getSchedulingStrategy
```
public String getSchedulingStrategy()
```
  Returns:
  
  The scheduling strategy that determines how the getSchedulingPeriod() value should be interpreted
- setSchedulingStrategy
```
public void setSchedulingStrategy(String schedulingStrategy)
```
- getProperties
```
public Map<String,String> getProperties()
```
  Returns:
  
  reporting task's properties
- setProperties
```
public void setProperties(Map<String,String> properties)
```
- getDescriptors
```
public Map<String,PropertyDescriptorDTO> getDescriptors()
```
  Returns:
  
  Map of property name to descriptor
- setDescriptors
```
public void setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)
```
- getSensitiveDynamicPropertyNames
```
public Set<String> getSensitiveDynamicPropertyNames()
```
  Returns:
  
  Set of sensitive dynamic property names
- setSensitiveDynamicPropertyNames
```
public void setSensitiveDynamicPropertyNames(Set<String> sensitiveDynamicPropertyNames)
```
- getCustomUiUrl
```
public String getCustomUiUrl()
```
  Returns:
  
  the URL for this reporting task custom configuration UI if applicable. Null otherwise
- setCustomUiUrl
```
public void setCustomUiUrl(String customUiUrl)
```
- getAnnotationData
```
public String getAnnotationData()
```
  Returns:
  
  currently configured annotation data for the reporting task
- setAnnotationData
```
public void setAnnotationData(String annotationData)
```
- getValidationErrors
```
public Collection<String> getValidationErrors()
```
  Gets the validation errors from this reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.
  
  Returns:
  
  The validation errors
- setValidationErrors
```
public void setValidationErrors(Collection<String> validationErrors)
```
- getValidationStatus
```
public String getValidationStatus()
```
- setValidationStatus
```
public void setValidationStatus(String validationStatus)
```
- getDefaultSchedulingPeriod
```
public Map<String,String> getDefaultSchedulingPeriod()
```
  Returns:
  
  default scheduling period for the different scheduling strategies
- setDefaultSchedulingPeriod
```
public void setDefaultSchedulingPeriod(Map<String,String> defaultSchedulingPeriod)
```
- getActiveThreadCount
```
public Integer getActiveThreadCount()
```
  Returns:
  
  number of active threads for this reporting task
- setActiveThreadCount
```
public void setActiveThreadCount(Integer activeThreadCount)
```

Class ReportingTaskDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.nifi.web.api.dto.ComponentDTO

Methods inherited from class java.lang.Object

Field Detail

VALID

INVALID

VALIDATING

name

type

bundle

state

comments

persistsState

restricted

deprecated

isExtensionMissing

multipleVersionsAvailable

supportsSensitiveDynamicProperties

schedulingPeriod

schedulingStrategy

defaultSchedulingPeriod

properties

descriptors

sensitiveDynamicPropertyNames

customUiUrl

annotationData

validationErrors

validationStatus

activeThreadCount

Constructor Detail

ReportingTaskDTO

Method Detail

getName

setName

getComments

setComments

getType

setType

getBundle

setBundle

getSchedulingPeriod

setSchedulingPeriod

getPersistsState

setPersistsState

getRestricted

setRestricted

getDeprecated

setDeprecated

getExtensionMissing

setExtensionMissing

getMultipleVersionsAvailable

setMultipleVersionsAvailable

getSupportsSensitiveDynamicProperties

setSupportsSensitiveDynamicProperties

getState

setState

getSchedulingStrategy

setSchedulingStrategy

getProperties

setProperties

getDescriptors

setDescriptors

getSensitiveDynamicPropertyNames

setSensitiveDynamicPropertyNames

getCustomUiUrl

setCustomUiUrl

getAnnotationData

setAnnotationData

getValidationErrors

setValidationErrors

getValidationStatus

setValidationStatus

getDefaultSchedulingPeriod

setDefaultSchedulingPeriod

getActiveThreadCount

setActiveThreadCount