ControllerDTO (nifi-client-dto 1.23.2 API)

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

```
public class ControllerDTO
extends Object
```
Configuration details for a NiFi controller. Primary use of this DTO is for consumption by a remote NiFi instance to initiate site to site communications.

Field Summary

Fields
Modifier and Type	Field and Description
`private Integer`	`activeRemotePortCount`
`private String`	`comments`
`private Integer`	`disabledCount`
`private String`	`id`
`private Integer`	`inactiveRemotePortCount`
`private Integer`	`inputPortCount`
`private Set<PortDTO>`	`inputPorts`
`private String`	`instanceId`
`private Integer`	`invalidCount`
`private String`	`name`
`private Integer`	`outputPortCount`
`private Set<PortDTO>`	`outputPorts`
`private Integer`	`remoteSiteHttpListeningPort`
`private Integer`	`remoteSiteListeningPort`
`private Integer`	`runningCount`
`private Boolean`	`siteToSiteSecure`
`private Integer`	`stoppedCount`

Constructor Summary

Constructors
Constructor and Description

ControllerDTO()

Constructors
Constructor and Description
`ControllerDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getActiveRemotePortCount()`
`String`	`getComments()`
`Integer`	`getDisabledCount()`
`String`	`getId()`
`Integer`	`getInactiveRemotePortCount()`
`Integer`	`getInputPortCount()`
`Set<PortDTO>`	`getInputPorts()`
`String`	`getInstanceId()`
`Integer`	`getInvalidCount()`
`String`	`getName()` The name of this NiFi controller.
`Integer`	`getOutputPortCount()`
`Set<PortDTO>`	`getOutputPorts()`
`Integer`	`getRemoteSiteHttpListeningPort()` The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files.
`Integer`	`getRemoteSiteListeningPort()` The Socket Port on which this instance is listening for Remote Transfers of Flow Files.
`Integer`	`getRunningCount()`
`Integer`	`getStoppedCount()`
`Boolean`	`isSiteToSiteSecure()`
`void`	`setActiveRemotePortCount(Integer activeRemotePortCount)`
`void`	`setComments(String comments)`
`void`	`setDisabledCount(Integer disabledCount)`
`void`	`setId(String id)`
`void`	`setInactiveRemotePortCount(Integer inactiveRemotePortCount)`
`void`	`setInputPortCount(Integer inputPortCount)`
`void`	`setInputPorts(Set<PortDTO> inputPorts)`
`void`	`setInstanceId(String instanceId)`
`void`	`setInvalidCount(Integer invalidCount)`
`void`	`setName(String name)`
`void`	`setOutputPortCount(Integer outputPortCount)`
`void`	`setOutputPorts(Set<PortDTO> outputPorts)`
`void`	`setRemoteSiteHttpListeningPort(Integer remoteSiteHttpListeningPort)`
`void`	`setRemoteSiteListeningPort(Integer port)`
`void`	`setRunningCount(Integer runningCount)`
`void`	`setSiteToSiteSecure(Boolean siteToSiteSecure)`
`void`	`setStoppedCount(Integer stoppedCount)`

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

- Field Detail
  - id
```
private String id
```
  - name
```
private String name
```
  - comments
```
private String comments
```
  - runningCount
```
private Integer runningCount
```
  - stoppedCount
```
private Integer stoppedCount
```
  - invalidCount
```
private Integer invalidCount
```
  - disabledCount
```
private Integer disabledCount
```
  - activeRemotePortCount
```
private Integer activeRemotePortCount
```
  - inactiveRemotePortCount
```
private Integer inactiveRemotePortCount
```
  - inputPortCount
```
private Integer inputPortCount
```
  - outputPortCount
```
private Integer outputPortCount
```
  - remoteSiteListeningPort
```
private Integer remoteSiteListeningPort
```
  - remoteSiteHttpListeningPort
```
private Integer remoteSiteHttpListeningPort
```
  - siteToSiteSecure
```
private Boolean siteToSiteSecure
```
  - instanceId
```
private String instanceId
```
  - inputPorts
```
private Set<PortDTO> inputPorts
```
  - outputPorts
```
private Set<PortDTO> outputPorts
```
- Constructor Detail
  - ControllerDTO
```
public ControllerDTO()
```
- Method Detail
  - getId
```
public String getId()
```
    Returns:
    
    id of this NiFi controller
  - setId
```
public void setId(String id)
```
  - getName
```
public String getName()
```
    The name of this NiFi controller.
    
    Returns:
    
    The name of this controller
  - setName
```
public void setName(String name)
```
  - getComments
```
public String getComments()
```
    Returns:
    
    comments of this NiFi controller
  - setComments
```
public void setComments(String comments)
```
  - getInputPorts
```
public Set<PortDTO> getInputPorts()
```
    Returns:
    
    input ports available to send data to this NiFi controller
  - setInputPorts
```
public void setInputPorts(Set<PortDTO> inputPorts)
```
  - getOutputPorts
```
public Set<PortDTO> getOutputPorts()
```
    Returns:
    
    output ports available to received data from this NiFi controller
  - setOutputPorts
```
public void setOutputPorts(Set<PortDTO> outputPorts)
```
  - getInstanceId
```
public String getInstanceId()
```
    Returns:
    
    Instance ID of the cluster, if this node is connected to a Cluster Manager, or of this individual instance of in standalone mode
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
  - getRemoteSiteListeningPort
```
public Integer getRemoteSiteListeningPort()
```
    The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.
    
    Returns:
    
    a integer between 1 and 65535, or null, if not configured for remote transfer
  - setRemoteSiteListeningPort
```
public void setRemoteSiteListeningPort(Integer port)
```
  - getRemoteSiteHttpListeningPort
```
public Integer getRemoteSiteHttpListeningPort()
```
    The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.
    
    Returns:
    
    a integer between 1 and 65535, or null, if not configured for remote transfer
  - setRemoteSiteHttpListeningPort
```
public void setRemoteSiteHttpListeningPort(Integer remoteSiteHttpListeningPort)
```
  - isSiteToSiteSecure
```
public Boolean isSiteToSiteSecure()
```
    Returns:
    
    Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication)
  - setSiteToSiteSecure
```
public void setSiteToSiteSecure(Boolean siteToSiteSecure)
```
  - getRunningCount
```
public Integer getRunningCount()
```
    Returns:
    
    number of running components in this process group
  - setRunningCount
```
public void setRunningCount(Integer runningCount)
```
  - getStoppedCount
```
public Integer getStoppedCount()
```
    Returns:
    
    number of stopped components in this process group
  - setStoppedCount
```
public void setStoppedCount(Integer stoppedCount)
```
  - getActiveRemotePortCount
```
public Integer getActiveRemotePortCount()
```
    Returns:
    
    number of active remote ports contained in this process group
  - setActiveRemotePortCount
```
public void setActiveRemotePortCount(Integer activeRemotePortCount)
```
  - getInactiveRemotePortCount
```
public Integer getInactiveRemotePortCount()
```
    Returns:
    
    number of inactive remote ports contained in this process group
  - setInactiveRemotePortCount
```
public void setInactiveRemotePortCount(Integer inactiveRemotePortCount)
```
  - getInputPortCount
```
public Integer getInputPortCount()
```
    Returns:
    
    number of input ports contained in this process group
  - setInputPortCount
```
public void setInputPortCount(Integer inputPortCount)
```
  - getInvalidCount
```
public Integer getInvalidCount()
```
    Returns:
    
    number of invalid components in this process group
  - setInvalidCount
```
public void setInvalidCount(Integer invalidCount)
```
  - getDisabledCount
```
public Integer getDisabledCount()
```
    Returns:
    
    number of disabled components in this process group
  - setDisabledCount
```
public void setDisabledCount(Integer disabledCount)
```
  - getOutputPortCount
```
public Integer getOutputPortCount()
```
    Returns:
    
    number of output ports in this process group
  - setOutputPortCount
```
public void setOutputPortCount(Integer outputPortCount)
```

Class ControllerDTO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

comments

runningCount

stoppedCount

invalidCount

disabledCount

activeRemotePortCount

inactiveRemotePortCount

inputPortCount

outputPortCount

remoteSiteListeningPort

remoteSiteHttpListeningPort

siteToSiteSecure

instanceId

inputPorts

outputPorts

Constructor Detail

ControllerDTO

Method Detail

getId

setId

getName

setName

getComments

setComments

getInputPorts

setInputPorts

getOutputPorts

setOutputPorts

getInstanceId

setInstanceId

getRemoteSiteListeningPort

setRemoteSiteListeningPort

getRemoteSiteHttpListeningPort

setRemoteSiteHttpListeningPort

isSiteToSiteSecure

setSiteToSiteSecure

getRunningCount

setRunningCount

getStoppedCount

setStoppedCount

getActiveRemotePortCount

setActiveRemotePortCount

getInactiveRemotePortCount

setInactiveRemotePortCount

getInputPortCount

setInputPortCount

getInvalidCount

setInvalidCount

getDisabledCount

setDisabledCount

getOutputPortCount

setOutputPortCount