ControllerServiceReferencingComponentDTO (nifi-client-dto 1.23.2 API)

java.lang.Object
- org.apache.nifi.web.api.dto.ControllerServiceReferencingComponentDTO

```
public class ControllerServiceReferencingComponentDTO
extends Object
```
A component referencing a controller service. This can either be another controller service or a processor. Depending on the type of component different properties may be set.

Field Summary

Fields
Modifier and Type	Field and Description
`private Integer`	`activeThreadCount`
`private Map<String,PropertyDescriptorDTO>`	`descriptors`
`private String`	`groupId`
`private String`	`id`
`private String`	`name`
`private Map<String,String>`	`properties`
`private Boolean`	`referenceCycle`
`private String`	`referenceType`
`private Set<ControllerServiceReferencingComponentEntity>`	`referencingComponents`
`private String`	`state`
`private String`	`type`
`private Collection<String>`	`validationErrors`

Constructor Summary

Constructors
Constructor and Description

ControllerServiceReferencingComponentDTO()

Constructors
Constructor and Description
`ControllerServiceReferencingComponentDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getActiveThreadCount()`
`Map<String,PropertyDescriptorDTO>`	`getDescriptors()`
`String`	`getGroupId()`
`String`	`getId()`
`String`	`getName()`
`Map<String,String>`	`getProperties()`
`Boolean`	`getReferenceCycle()`
`String`	`getReferenceType()`
`Set<ControllerServiceReferencingComponentEntity>`	`getReferencingComponents()`
`String`	`getState()`
`String`	`getType()`
`Collection<String>`	`getValidationErrors()`
`void`	`setActiveThreadCount(Integer activeThreadCount)`
`void`	`setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)`
`void`	`setGroupId(String groupId)`
`void`	`setId(String id)`
`void`	`setName(String name)`
`void`	`setProperties(Map<String,String> properties)`
`void`	`setReferenceCycle(Boolean referenceCycle)`
`void`	`setReferenceType(String referenceType)`
`void`	`setReferencingComponents(Set<ControllerServiceReferencingComponentEntity> referencingComponents)`
`void`	`setState(String state)`
`void`	`setType(String type)`
`void`	`setValidationErrors(Collection<String> validationErrors)`

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

Field Detail

groupId
```
private String groupId
```

id
```
private String id
```

name
```
private String name
```

type
```
private String type
```

state
```
private String state
```

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

descriptors

private Map<String,PropertyDescriptorDTO> descriptors

validationErrors

private Collection<String> validationErrors

referenceType
```
private String referenceType
```

activeThreadCount
```
private Integer activeThreadCount
```

referenceCycle
```
private Boolean referenceCycle
```

referencingComponents

private Set<ControllerServiceReferencingComponentEntity> referencingComponents

Constructor Detail
- ControllerServiceReferencingComponentDTO
```
public ControllerServiceReferencingComponentDTO()
```

Method Detail
- getGroupId
```
public String getGroupId()
```
  Returns:
  
  Group id for this component referencing a controller service. If this component is another service, this field is blank
- setGroupId
```
public void setGroupId(String groupId)
```
- getId
```
public String getId()
```
  Returns:
  
  id for this component referencing a controller service
- setId
```
public void setId(String id)
```
- getName
```
public String getName()
```
  Returns:
  
  name for this component referencing a controller service
- setName
```
public void setName(String name)
```
- getType
```
public String getType()
```
  Returns:
  
  type for this component referencing a controller service
- setType
```
public void setType(String type)
```
- getState
```
public String getState()
```
  Returns:
  
  scheduled state of the processor referencing a controller service. If this component is another service, this field represents the controller service state
- setState
```
public void setState(String state)
```
- getReferenceType
```
public String getReferenceType()
```
  Returns:
  
  type of reference this is (Processor, ControllerService, ParameterProvider, or ReportingTask)
- setReferenceType
```
public void setReferenceType(String referenceType)
```
- getProperties
```
public Map<String,String> getProperties()
```
  Returns:
  
  component properties
- setProperties
```
public void setProperties(Map<String,String> properties)
```
- getDescriptors
```
public Map<String,PropertyDescriptorDTO> getDescriptors()
```
  Returns:
  
  descriptors for the components properties
- setDescriptors
```
public void setDescriptors(Map<String,PropertyDescriptorDTO> descriptors)
```
- getValidationErrors
```
public Collection<String> getValidationErrors()
```
  Returns:
  
  Any validation error associated with this component
- setValidationErrors
```
public void setValidationErrors(Collection<String> validationErrors)
```
- getActiveThreadCount
```
public Integer getActiveThreadCount()
```
  Returns:
  
  active thread count for the referencing component
- setActiveThreadCount
```
public void setActiveThreadCount(Integer activeThreadCount)
```
- getReferencingComponents
```
public Set<ControllerServiceReferencingComponentEntity> getReferencingComponents()
```
  Returns:
  
  If this referencing component represents a ControllerService, these are the components that reference it
- setReferencingComponents
```
public void setReferencingComponents(Set<ControllerServiceReferencingComponentEntity> referencingComponents)
```
- getReferenceCycle
```
public Boolean getReferenceCycle()
```
  Returns:
  
  If this referencing component represents a ControllerService, this indicates whether it has already been represented in this hierarchy
- setReferenceCycle
```
public void setReferenceCycle(Boolean referenceCycle)
```

Class ControllerServiceReferencingComponentDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

groupId

id

name

type

state

properties

descriptors

validationErrors

referenceType

activeThreadCount

referenceCycle

referencingComponents

Constructor Detail

ControllerServiceReferencingComponentDTO

Method Detail

getGroupId

setGroupId

getId

setId

getName

setName

getType

setType

getState

setState

getReferenceType

setReferenceType

getProperties

setProperties

getDescriptors

setDescriptors

getValidationErrors

setValidationErrors

getActiveThreadCount

setActiveThreadCount

getReferencingComponents

setReferencingComponents

getReferenceCycle

setReferenceCycle