PortDTO (nifi-client-dto 1.23.2 API)

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

```
public class PortDTO
extends ComponentDTO
```
The details for a port within this NiFi flow.

Field Summary

Fields
Modifier and Type	Field and Description
`private Boolean`	`allowRemoteAccess`
`private String`	`comments`
`private Integer`	`concurrentlySchedulableTaskCount`
`private Set<String>`	`groupAccessControl`
`private String`	`name`
`private String`	`state`
`private Boolean`	`transmitting`
`private String`	`type`
`private Set<String>`	`userAccessControl`
`private Collection<String>`	`validationErrors`

Constructor Summary

Constructors
Constructor and Description

PortDTO()

Constructors
Constructor and Description
`PortDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getAllowRemoteAccess()`
`String`	`getComments()`
`Integer`	`getConcurrentlySchedulableTaskCount()`
`Set<String>`	`getGroupAccessControl()`
`String`	`getName()`
`String`	`getState()`
`String`	`getType()` The type of port.
`Set<String>`	`getUserAccessControl()`
`Collection<String>`	`getValidationErrors()` Gets the validation errors from this port.
`Boolean`	`isTransmitting()`
`void`	`setAllowRemoteAccess(Boolean allowRemoteAccess)`
`void`	`setComments(String comments)`
`void`	`setConcurrentlySchedulableTaskCount(Integer concurrentlySchedulableTaskCount)`
`void`	`setGroupAccessControl(Set<String> groupAccessControl)`
`void`	`setName(String name)`
`void`	`setState(String state)`
`void`	`setTransmitting(Boolean transmitting)`
`void`	`setType(String type)`
`void`	`setUserAccessControl(Set<String> userAccessControl)`
`void`	`setValidationErrors(Collection<String> validationErrors)`

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

name
```
private String name
```

comments
```
private String comments
```

state
```
private String state
```

type
```
private String type
```

transmitting
```
private Boolean transmitting
```

concurrentlySchedulableTaskCount

private Integer concurrentlySchedulableTaskCount

userAccessControl
```
private Set<String> userAccessControl
```

groupAccessControl
```
private Set<String> groupAccessControl
```

allowRemoteAccess
```
private Boolean allowRemoteAccess
```

validationErrors

private Collection<String> validationErrors

Constructor Detail
- PortDTO
```
public PortDTO()
```

Method Detail
- getName
```
public String getName()
```
  Returns:
  
  name of this port
- setName
```
public void setName(String name)
```
- getState
```
public String getState()
```
  Returns:
  
  The state of this port. Possible states are 'RUNNING', 'STOPPED', and 'DISABLED'
- setState
```
public void setState(String state)
```
- getType
```
public String getType()
```
  The type of port. Possible values are 'INPUT_PORT' or 'OUTPUT_PORT'.
  
  Returns:
  
  The type of port
- setType
```
public void setType(String type)
```
- getConcurrentlySchedulableTaskCount
```
public Integer getConcurrentlySchedulableTaskCount()
```
  Returns:
  
  number of tasks that should be concurrently scheduled for this port
- setConcurrentlySchedulableTaskCount
```
public void setConcurrentlySchedulableTaskCount(Integer concurrentlySchedulableTaskCount)
```
- getComments
```
public String getComments()
```
  Returns:
  
  comments for this port
- setComments
```
public void setComments(String comments)
```
- isTransmitting
```
public Boolean isTransmitting()
```
  Returns:
  
  whether this port has incoming or outgoing connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely.
- setTransmitting
```
public void setTransmitting(Boolean transmitting)
```
- getGroupAccessControl
```
public Set<String> getGroupAccessControl()
```
  Returns:
  
  groups that are allowed to access this port
- setGroupAccessControl
```
public void setGroupAccessControl(Set<String> groupAccessControl)
```
- getUserAccessControl
```
public Set<String> getUserAccessControl()
```
  Returns:
  
  users that are allowed to access this port
- setUserAccessControl
```
public void setUserAccessControl(Set<String> userAccessControl)
```
- getValidationErrors
```
public Collection<String> getValidationErrors()
```
  Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.
  
  Returns:
  
  The validation errors
- setValidationErrors
```
public void setValidationErrors(Collection<String> validationErrors)
```
- getAllowRemoteAccess
```
public Boolean getAllowRemoteAccess()
```
  Returns:
  
  whether this port can be accessed remotely via Site-to-Site protocol.
- setAllowRemoteAccess
```
public void setAllowRemoteAccess(Boolean allowRemoteAccess)
```

Class PortDTO

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

name

comments

state

type

transmitting

concurrentlySchedulableTaskCount

userAccessControl

groupAccessControl

allowRemoteAccess

validationErrors

Constructor Detail

PortDTO

Method Detail

getName

setName

getState

setState

getType

setType

getConcurrentlySchedulableTaskCount

setConcurrentlySchedulableTaskCount

getComments

setComments

isTransmitting

setTransmitting

getGroupAccessControl

setGroupAccessControl

getUserAccessControl

setUserAccessControl

getValidationErrors

setValidationErrors

getAllowRemoteAccess

setAllowRemoteAccess