ConnectionDTO (nifi-client-dto 1.23.2 API)

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

public class ConnectionDTO
extends ComponentDTO

A connection between two connectable components.

Field Summary

Fields
Modifier and Type	Field and Description
`private Set<String>`	`availableRelationships`
`private String`	`backPressureDataSizeThreshold`
`private Long`	`backPressureObjectThreshold`
`private List<PositionDTO>`	`bends`
`private ConnectableDTO`	`destination`
`private String`	`flowFileExpiration`
`private Integer`	`labelIndex`
`static String`	`LOAD_BALANCE_ACTIVE`
`static String`	`LOAD_BALANCE_INACTIVE`
`static String`	`LOAD_BALANCE_NOT_CONFIGURED`
`private String`	`loadBalanceCompression`
`private String`	`loadBalancePartitionAttribute`
`private String`	`loadBalanceStatus`
`private String`	`loadBalanceStrategy`
`private String`	`name`
`private List<String>`	`prioritizers`
`private Set<String>`	`selectedRelationships`
`private ConnectableDTO`	`source`
`private Long`	`zIndex`

Constructor Summary

Constructors
Constructor and Description

ConnectionDTO()

Constructors
Constructor and Description
`ConnectionDTO()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Set<String>`	`getAvailableRelationships()`
`String`	`getBackPressureDataSizeThreshold()` The object data size threshold for determining when back pressure is applied.
`Long`	`getBackPressureObjectThreshold()` The object count threshold for determining when back pressure is applied.
`List<PositionDTO>`	`getBends()`
`ConnectableDTO`	`getDestination()` The destination of this connection.
`String`	`getFlowFileExpiration()` The amount of time a flow file may be in the flow before it will be automatically aged out of the flow.
`Integer`	`getLabelIndex()`
`String`	`getLoadBalanceCompression()`
`String`	`getLoadBalancePartitionAttribute()`
`String`	`getLoadBalanceStatus()`
`String`	`getLoadBalanceStrategy()`
`String`	`getName()`
`List<String>`	`getPrioritizers()` The prioritizers this connection is using.
`Set<String>`	`getSelectedRelationships()` The relationships that make up this connection.
`ConnectableDTO`	`getSource()` The source of this connection.
`Long`	`getzIndex()`
`void`	`setAvailableRelationships(Set<String> availableRelationships)`
`void`	`setBackPressureDataSizeThreshold(String backPressureDataSizeThreshold)`
`void`	`setBackPressureObjectThreshold(Long backPressureObjectThreshold)`
`void`	`setBends(List<PositionDTO> bends)`
`void`	`setDestination(ConnectableDTO destination)`
`void`	`setFlowFileExpiration(String flowFileExpiration)`
`void`	`setLabelIndex(Integer labelIndex)`
`void`	`setLoadBalanceCompression(String compression)`
`void`	`setLoadBalancePartitionAttribute(String partitionAttribute)`
`void`	`setLoadBalanceStatus(String status)`
`void`	`setLoadBalanceStrategy(String loadBalanceStrategy)`
`void`	`setName(String name)`
`void`	`setPrioritizers(List<String> prioritizers)`
`void`	`setSelectedRelationships(Set<String> relationships)`
`void`	`setSource(ConnectableDTO source)`
`void`	`setzIndex(Long zIndex)`
`String`	`toString()`

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

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

- Field Detail
  - LOAD_BALANCE_NOT_CONFIGURED
```
public static final String LOAD_BALANCE_NOT_CONFIGURED
```
    See Also:
    
    Constant Field Values
  - LOAD_BALANCE_INACTIVE
```
public static final String LOAD_BALANCE_INACTIVE
```
    See Also:
    
    Constant Field Values
  - LOAD_BALANCE_ACTIVE
```
public static final String LOAD_BALANCE_ACTIVE
```
    See Also:
    
    Constant Field Values
  - source
```
private ConnectableDTO source
```
  - destination
```
private ConnectableDTO destination
```
  - name
```
private String name
```
  - labelIndex
```
private Integer labelIndex
```
  - zIndex
```
private Long zIndex
```
  - selectedRelationships
```
private Set<String> selectedRelationships
```
  - availableRelationships
```
private Set<String> availableRelationships
```
  - backPressureObjectThreshold
```
private Long backPressureObjectThreshold
```
  - backPressureDataSizeThreshold
```
private String backPressureDataSizeThreshold
```
  - flowFileExpiration
```
private String flowFileExpiration
```
  - prioritizers
```
private List<String> prioritizers
```
  - bends
```
private List<PositionDTO> bends
```
  - loadBalanceStrategy
```
private String loadBalanceStrategy
```
  - loadBalancePartitionAttribute
```
private String loadBalancePartitionAttribute
```
  - loadBalanceCompression
```
private String loadBalanceCompression
```
  - loadBalanceStatus
```
private String loadBalanceStatus
```
- Constructor Detail
  - ConnectionDTO
```
public ConnectionDTO()
```
- Method Detail
  - getSource
```
public ConnectableDTO getSource()
```
    The source of this connection.
    
    Returns:
    
    The source of this connection
  - setSource
```
public void setSource(ConnectableDTO source)
```
  - getDestination
```
public ConnectableDTO getDestination()
```
    The destination of this connection.
    
    Returns:
    
    The destination of this connection
  - setDestination
```
public void setDestination(ConnectableDTO destination)
```
  - getName
```
public String getName()
```
    Returns:
    
    name of the connection
  - setName
```
public void setName(String name)
```
  - getBends
```
public List<PositionDTO> getBends()
```
    Returns:
    
    position of the bend points on this connection
  - setBends
```
public void setBends(List<PositionDTO> bends)
```
  - getLabelIndex
```
public Integer getLabelIndex()
```
    Returns:
    
    The index of control point that the connection label should be placed over
  - setLabelIndex
```
public void setLabelIndex(Integer labelIndex)
```
  - getzIndex
```
public Long getzIndex()
```
    Returns:
    
    z index for this connection
  - setzIndex
```
public void setzIndex(Long zIndex)
```
  - getSelectedRelationships
```
public Set<String> getSelectedRelationships()
```
    The relationships that make up this connection.
    
    Returns:
    
    The relationships
  - setSelectedRelationships
```
public void setSelectedRelationships(Set<String> relationships)
```
  - getAvailableRelationships
```
public Set<String> getAvailableRelationships()
```
    Returns:
    
    relationships that the source of the connection currently supports. This property is read only
  - setAvailableRelationships
```
public void setAvailableRelationships(Set<String> availableRelationships)
```
  - getBackPressureObjectThreshold
```
public Long getBackPressureObjectThreshold()
```
    The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
    
    Returns:
    
    The back pressure object threshold
  - setBackPressureObjectThreshold
```
public void setBackPressureObjectThreshold(Long backPressureObjectThreshold)
```
  - getBackPressureDataSizeThreshold
```
public String getBackPressureDataSizeThreshold()
```
    The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
    
    Returns:
    
    The back pressure data size threshold
  - setBackPressureDataSizeThreshold
```
public void setBackPressureDataSizeThreshold(String backPressureDataSizeThreshold)
```
  - getFlowFileExpiration
```
public String getFlowFileExpiration()
```
    The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.
    
    Returns:
    
    The flow file expiration in minutes
  - setFlowFileExpiration
```
public void setFlowFileExpiration(String flowFileExpiration)
```
  - getPrioritizers
```
public List<String> getPrioritizers()
```
    The prioritizers this connection is using.
    
    Returns:
    
    The prioritizer list
  - setPrioritizers
```
public void setPrioritizers(List<String> prioritizers)
```
  - getLoadBalanceStrategy
```
public String getLoadBalanceStrategy()
```
  - setLoadBalanceStrategy
```
public void setLoadBalanceStrategy(String loadBalanceStrategy)
```
  - getLoadBalancePartitionAttribute
```
public String getLoadBalancePartitionAttribute()
```
  - setLoadBalancePartitionAttribute
```
public void setLoadBalancePartitionAttribute(String partitionAttribute)
```
  - getLoadBalanceCompression
```
public String getLoadBalanceCompression()
```
  - setLoadBalanceCompression
```
public void setLoadBalanceCompression(String compression)
```
  - getLoadBalanceStatus
```
public String getLoadBalanceStatus()
```
  - setLoadBalanceStatus
```
public void setLoadBalanceStatus(String status)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class ComponentDTO

Class ConnectionDTO

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

LOAD_BALANCE_NOT_CONFIGURED

LOAD_BALANCE_INACTIVE

LOAD_BALANCE_ACTIVE

source

destination

name

labelIndex

zIndex

selectedRelationships

availableRelationships

backPressureObjectThreshold

backPressureDataSizeThreshold

flowFileExpiration

prioritizers

bends

loadBalanceStrategy

loadBalancePartitionAttribute

loadBalanceCompression

loadBalanceStatus

Constructor Detail

ConnectionDTO

Method Detail

getSource

setSource

getDestination

setDestination

getName

setName

getBends

setBends

getLabelIndex

setLabelIndex

getzIndex

setzIndex

getSelectedRelationships

setSelectedRelationships

getAvailableRelationships

setAvailableRelationships

getBackPressureObjectThreshold

setBackPressureObjectThreshold

getBackPressureDataSizeThreshold

setBackPressureDataSizeThreshold

getFlowFileExpiration

setFlowFileExpiration

getPrioritizers

setPrioritizers

getLoadBalanceStrategy

setLoadBalanceStrategy

getLoadBalancePartitionAttribute

setLoadBalancePartitionAttribute

getLoadBalanceCompression

setLoadBalanceCompression

getLoadBalanceStatus

setLoadBalanceStatus

toString